¿Cómo puedo mantener los comentarios XML para las descripciones de métodos en un archivo separado?

Question

Esta pregunta proviene de esta pregunta Documentación del código ¿cuánto es demasiado?

Una de las respuestas fue mantener su documentación xml en un archivo separado. Realmente me gustó esa respuesta, ya que cuando estoy revisando el código, la verbosidad de la documentación es molesta, por otra parte, esa verbosidad es útil cuando se busca el método correcto a través de intellisense o se publica la documentación.

La respuesta fue usar la etiqueta de inclusión

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

También hay un artículo de MSDN sobre la etiqueta de inclusión aquí.

Descubrí cómo mantener la información del resumen, pero no sé y tampoco pude encontrar la forma de poner la documentación del método allí. (que es más importante que el resumen de la clase en sí.

Answer 1

La respuesta es simple. Lee los archivos xml producidos. Dan una idea de cómo deben ser los archivos xml separados.

Lectura de los archivos xml producidos y cómo se describe el método (con parámetros y tales):

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

Prefijos T, M, F Tipo, Método, Campo.