Come posso conservare i commenti XML per le descrizioni dei metodi in un file separato?

Question

Questa domanda nasce da questa domanda Documentazione sul codice quanto costa troppo?

Una delle risposte è stata quella di conservare la documentazione XML in un file separato. Mi è piaciuta molto quella risposta, dato che quando guardo il codice la fastidiosità della documentazione è fastidiosa, d'altra parte la verbosità è utile quando si cerca il metodo giusto tramite intellisense o si pubblica la documentazione.

La risposta era usare il tag include

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

Esiste anche un articolo MSDN sul tag include qui.

Ho capito come tenere fuori le informazioni di riepilogo, ma non lo so e non sono riuscito a trovarlo come inserire anche la documentazione del metodo. (che è più importante del sommario stesso della classe.

Answer 1

La risposta è semplice. Leggi i file xml prodotti. Danno un'idea di come dovrebbero apparire i file xml separati.

Lettura dei file xml prodotti e come viene descritto il metodo (con parametri e simili):

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

Prefissi T, M, F Tipo, Metodo, Campo.