Questions marquées «documentation»

La documentation du logiciel est un texte écrit qui accompagne les logiciels informatiques. Il explique comment le logiciel fonctionne, comment l'installer, comment l'utiliser et d'autres ressources d'aide.

5
Documentation du code: publique ou non publique?
Je fais partie de ces développeurs qui pensent que le code écrit doit être explicite et se lire comme un livre. TOUTEFOIS, lors du développement de code de bibliothèque pour d'autres personnes, j'essaie de mettre autant de documentation que possible dans les fichiers d'en-tête; ce qui soulève la question: la …
1
Précision implicite des fonctions à virgule flottante
Lors de l'examen de l' implémentation d'une fonction par un autre programmeur pour calculer le CDF de distribution normale , j'ai suggéré de remplacer l'intégralité de l'implémentation par les fonctions intégrées de Python ou d'utiliser SciPy, une bibliothèque scientifique commune. Un autre programmeur a souligné que ni math.erfc()ne scipy.stats.norm.cdf()fournit aucune …
1
Comment garder à jour les exemples de code dans javadocs
Je travaille sur une petite bibliothèque qui fournit des implémentations de métriques de chaîne de base bien connues. Surtout pour ma propre éducation. Le développement se produit donc chaque fois que j'ai un peu de temps libre. Pour cette raison, j'ai automatisé la plupart des processus afin que je puisse …
4
Devrions-nous chercher du code mensonger?
Cela fait référence à une discussion dans une réponse et aux commentaires de cette question: Quelle est l'aversion pour la documentation dans l'industrie? . La réponse affirmait que «le code ne peut pas mentir» et devrait donc être l'emplacement de référence au lieu de la documentation. Plusieurs commentaires ont souligné …
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.