Comment puis-je conserver les commentaires XML pour les descriptions de méthode dans un fichier distinct?

Question

Cette question découle de cette question Code documentation how much is too much?

Une des réponses a été de garder votre documentation xml dans un fichier séparé. J'ai vraiment aimé cette réponse car lorsque je regarde dans le code, la verbosité de la documentation est gênante, d'autre part que la verbosité est utile quand on cherche la bonne méthode via intellisense ou en publiant la documentation.

La réponse était d'utiliser la balise include

/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/> 

Il y a aussi un article MSDN sur le balise include here.

je me suis dit comment garder l'information sommaire, mais je ne sais pas et je ne pouvais pas trouver comment mettre la documentation de la méthode là aussi. (Ce qui est plus important que le résumé de la classe elle-même.

Answer 1

La réponse est simple. Lire les fichiers xml produits. Ils donnent une idée de comment les fichiers XML séparés devraient ressembler.

La lecture des fichiers xml produits et comment méthode est décrite (avec des paramètres et autres):.

<member name="M:BitFactory.Logging.Logger.DoLog(BitFactory.Logging.LogEntry)"> 
    <summary> 
    Really log aLogEntry. (We are past filtering at this point.) 
    Subclasses might want to do something more interesting and override this method. 
    </summary> 
    <param name="aLogEntry">The LogEntry to log</param> 
    <returns>true upon success, false upon failure.</returns> 
</member> 

T, M, F type préfixes, méthode, Champ