Como posso manter comentários XML para descrições de métodos em um arquivo separado?
-
03-07-2019 - |
Pergunta
Esta questão decorre esta pergunta documentação Código o quanto é demais?
Uma das respostas foi de manter a documentação xml em um arquivo separado. Eu realmente gostei que resposta como quando eu estou olhando através do código a verbosidade da documentação é irritante, por outro lado, que a verbosidade é útil quando procurar o método certo via intellisense ou publicar a documentação.
A resposta era usar a tag incluem
/// <include file="Documentation/XML/YourClass.xml" path="//documentation/members[@name='YourClass']/*"/>
Há também um artigo do MSDN sobre a tag incluem aqui.
Eu descobri como para manter a informação para fora resumo, mas eu não sei e eu não poderia encontrá-lo como colocar a documentação do método lá também. (O que é mais importante do que o próprio resumo classe.
Solução
A resposta é simples. Leia os arquivos XML produzidos. Eles dão uma idéia de como os arquivos XML separados deve ser parecida.
A leitura dos arquivos XML produzidos e como método é descrito (com parâmetros e tal):
<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 prefixos Type, Método, Campo.