Wie kann ich XML-Kommentare für Methodenbeschreibungen in einer separaten Datei?

Question

Diese Frage ergibt sich aus dieser Frage -Code-Dokumentation, wie viel zu viel ist?

Das eine war die Antworten Ihrer XML-Dokumentation in einer separaten Datei zu halten. Ich mochte diese Antwort, wie wenn ich durch den Code suchen die Ausführlichkeit der Dokumentation ärgerlich ist, auf der anderen Seite, dass Ausführlichkeit sehr nützlich ist, wenn für die richtige Methode über Intellisense oder Veröffentlichung der Dokumentation zu suchen.

Die Antwort war zu verwenden, die enthalten Tag

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

Es gibt auch einen MSDN-Artikel über den Tag enthalten hier.

ich herausgefunden, wie die Zusammenfassung Informationen zu halten, aber ich weiß nicht, und ich kann ihn nicht finden, wie die Methode Dokumentation setzt auch dort. (Das ist wichtiger als die Klasse Zusammenfassung selbst.

Answer 1

Die Antwort ist einfach. Lesen Sie die erzeugten XML-Dateien. Sie geben eine Vorstellung davon, wie die getrennten XML-Dateien aussehen sollte.

Beim Lesen der erzeugten XML-Dateien und wie Verfahren beschrieben (mit Parametern und so weiter):

<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 Präfix Typ, Methode, Feld.