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.

8
Devez-vous tout documenter ou juste la plupart?
Cela semble un peu un sujet controversé de tout documenter, y compris la syntaxe "JavaBean" des getters et des setters pour les champs: les gens disent que sa rupture inutilement longue et répétitive DRY (ne vous répétez pas) , que la convention de nommage devrait tout expliquer , et il …
4
Comment documenter la structure de haut niveau d'un programme Java?
Contexte: Mes collaborateurs et moi écrivons un article pour une revue universitaire. Au cours de nos recherches, nous avons écrit un programme de simulation en Java. Nous voulons rendre le programme de simulation disponible gratuitement pour que d'autres puissent l'utiliser. Nous avons décidé d'héberger le code sur un référentiel GitHub. …
1
Duplication de la documentation sur les implémentations / remplacements d'interfaces bonne ou mauvaise?
Nous avons donc une interface comme ça /// <summary> /// Interface for classes capable of creating foos /// </summary> public interface ICreatesFoo { /// <summary> /// Creates foos /// </summary> void Create(Foo foo); /// <summary> /// Does Bar stuff /// </summary> void Bar(); } Récemment, nous avons joué une histoire …
4
Documenter la logique mathématique dans le code
Parfois, mais pas souvent, je dois inclure la logique mathématique dans mon code. Les concepts utilisés sont pour la plupart très simples, mais le code qui en résulte ne l'est pas - beaucoup de variables avec un but peu clair, et certaines opérations avec une intention pas si évidente. Je …
6
Code auto-documenté vs Javadocs?
Récemment, j'ai travaillé sur la refactorisation de parties de la base de code que je traite actuellement - non seulement pour mieux le comprendre moi-même, mais aussi pour le rendre plus facile pour les autres qui travaillent sur le code. J'ai tendance à me pencher du côté de penser que …
11
Que devez-vous laisser pour vos successeurs?
Supposons que vous êtes l'unique développeur à quitter un emploi. Quel type d'information / matériel, en dehors du code lui-même, devez-vous créer et laisser pour votre remplacement? Une réponse évidente est "tout ce que vous voudriez à un nouvel emploi", c'est sûr, mais cela fait un moment que j'ai commencé …
2
Quelle norme a remplacé la 830-1998?
J'ai cherché à documenter les projets logiciels de manière plus formelle et j'ai découvert IEEE 830-1998: Pratique recommandée pour les spécifications des exigences logicielles . Cependant, comme vous pouvez le voir sur ce lien, il a été remplacé. Je sais que 830-1998, et probablement même 830-1993, sont probablement très bien …
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.