3
Existe-t-il un générateur de documentation personnalisable pour C#? Contrairement à la documentation XML native qui fournit des documentations pour les classes, les méthodes, les propriétés, la documentation à laquelle je fais référence ici est de plus bas niveau, c'est-à-dire qu'elle documente le flux d'une méthode.documentation personnalisée pour le code C#
par exemple dans le code donné
void SomeMethod(){
///doc:Do X
SomeCodeToDoX
///doc:Do Y
SomeCodeToDoY
///not tagged
SomeCode
}
La documentation capturera doc: Do X et doc: Do Y et documentera Do X et Do Y comme le flux dans la méthode SomeMethod
** J'espère que je fait la question assez claire .. si je ne l'ai pas s'il vous plaît commentaire à demander des éclaircissements *
Idée intéressante, mais je dirais que si vos méthodes sont si grands et complexes qu'ils ont besoin de documentation * à l'intérieur * de la méthode, alors vous devrez probablement refactoriser, plutôt que d'essayer de le faire ... –
Je ne voudrais pas exposer ce genre de commentaire. Il pourrait empêcher les programmeurs de commenter le code "à l'intérieur de la boîte" –
@graphain: Mon idée est d'avoir une balise qui indique que ce commentaire fait partie de la documentation, sans la balise les commentaires ne seraient pas documentés –