Comment puis-je conserver des commentaires XML pour les descriptions de méthodes dans un fichier séparé?

Question

Cette question découle de cette question Documentation sur le code: combien coûte trop?

L'une des solutions consistait à conserver 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, par contre, cette verbosité est utile pour rechercher la bonne méthode via intellisense ou pour publier la documentation.

La réponse consistait à utiliser la balise include

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

Il existe également un article MSDN sur la balise include ici.

J'ai compris comment conserver les informations de synthèse, mais je ne le savais pas et je ne trouvais pas comment y mettre la documentation de la méthode. (ce qui est plus important que le résumé de classe lui-même.

Answer 1

La réponse est simple. Lire les fichiers XML produits. Ils donnent une idée de la forme que devraient avoir les fichiers XML séparés.

Lecture des fichiers XML produits et description de la méthode (avec paramètres, etc.):

<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>

Préfixes T, M, F Type, Méthode, Champ.