Outil de documentation de code source

Question

?

Merci.

Answer 1

utilisation open source Sandcastle pour la documentation du code .net

Answer 2

GhostDoc est ce que j'utilise. Excellent outil.

Answer 3

Si vous voulez que votre documentation pour contenir quoi que ce soit, sauf les choses qui sont déjà connues de la signature, le seul outil utile est ici ... vous. Cela et certains /// (C#) ou ''' (VB) amusant. Il sont outils qui vont générer des choses comme "obtient ou définit le FrobCount", mais finalement ... qu'avez-vous pense la propriété FrobCount {get;set;} fait?

BTW, par ce que je ne dire « ne prends pas la peine d'ajouter ces commentaires » - ils ont un certain sens ... mais je crains que vous prenez l'habitude de juste en utilisant l'outillage automatique. En fin de compte, cela ajoute très peu de valeur supplémentaire. La valeur provient de la connaissance de la sémantique, de l'utilisation prévue, des effets secondaires, etc. Aucun outil automatisé ne générera cela.

Answer 4

Nous utilisons DocumentX.