[Dica] Documentando código através de XML Documentation
29/03/2018
0
Olá pessoal, blz!
Existe uma forma interessante de documentar o código através de XML Documentation. Funciona assim:
A documentação é sempre feita na seção *interface*, acima do método, classe e/ou record e, caso contenha alguma falha de sintaxe a descrição não será apresentada. As principais tags utilizadas são seguintes:
<summary>: Uma breve descrição sobre o proposito do método
<param name=?NomeDoParametro>: Uma descrição sobre um determinado parâmetro, identificado pelo seu nome dentro da tag xml.
<returns>: Uma descrição sobre o retorno do método, particularmente útil quando um método pode voltar determinados códigos de falha ou sucesso.
<remarks>: Uma possível observação sobre o método.
<exception cref=?NomeDaExceção?>: Referencia e observação a uma possível exceção na execução do método.
Forte abraço[]
Essa dúvida foi gerada a partir de um comentário no artigo [url:descricao=Artigo Clube Delphi Edição 50 - Documentação de Código Fonte]//www.devmedia.com.br/artigo-clube-delphi-edicao-50-documentacao-de-codigo-fonte/13649[/url]
Existe uma forma interessante de documentar o código através de XML Documentation. Funciona assim:
/// <summary>Método que realiza o processamento principal dos arquivos de movimentos mensais gerando o agrupamento central</summary> /// <param name="ACaminho">Caminho do arquivo de parametrização da geração do agrupamento central</param> /// <returns>True se o processamento foi ok e False para possíveis exceções</returns> /// <remarks>Em caso de falha verificar os arquivos de log</remarks> /// <exception cref="EIOErro">Caso o arquivo de referencia não exista</exception> /// <exception cref="EProcErro">Caso falhe o processamento</exception> function RealizarProcessamentoCentral(const ACaminho : string):boolean;
A documentação é sempre feita na seção *interface*, acima do método, classe e/ou record e, caso contenha alguma falha de sintaxe a descrição não será apresentada. As principais tags utilizadas são seguintes:
<summary>: Uma breve descrição sobre o proposito do método
<param name=?NomeDoParametro>: Uma descrição sobre um determinado parâmetro, identificado pelo seu nome dentro da tag xml.
<returns>: Uma descrição sobre o retorno do método, particularmente útil quando um método pode voltar determinados códigos de falha ou sucesso.
<remarks>: Uma possível observação sobre o método.
<exception cref=?NomeDaExceção?>: Referencia e observação a uma possível exceção na execução do método.
Forte abraço[]
Essa dúvida foi gerada a partir de um comentário no artigo [url:descricao=Artigo Clube Delphi Edição 50 - Documentação de Código Fonte]//www.devmedia.com.br/artigo-clube-delphi-edicao-50-documentacao-de-codigo-fonte/13649[/url]
Lucas Guimarães
Curtir tópico
+ 1
Responder
Clique aqui para fazer login e interagir na Comunidade :)
