Existe um padrão (como phpdoc ou docstring do python) para comentar código C#?

Question

Existe uma convenção padrão (como phpdoc ou docstring do python) para comentar o código C# para que a documentação da classe possa ser gerada automaticamente a partir do código-fonte?

Answer 1

Você pode usar comentários no estilo XML e usar ferramentas para extrair esses comentários da documentação da API.

Aqui está um exemplo do estilo de comentário:

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)

Alguns itens para facilitar isso são:

GhostDoc, que fornece uma única tecla de atalho para gerar comentários automaticamente para uma classe ou método.Castelo de Areia, que gera documentação no estilo MSDN a partir de comentários XML.

Answer 2

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

A Microsoft usa "Comentários da documentação XML" que fornecerá descrições intellisense do IDE e também permitirá gerar automaticamente documentação no estilo MSDN usando uma ferramenta como o Sandcastle se você ativar a geração da saída do arquivo XML.

Para ativar a geração do arquivo XML para documentação, clique com o botão direito em um projeto no visual studio, clique em “Propriedades” e vá até a aba “Construir”.Na parte inferior, você pode especificar um local para o arquivo de saída de comentários XML.

Answer 4

As respostas anteriores apontam perfeitamente a sintaxe XML.Eu só queria deixar minha recomendação para o gerador de biblioteca de ajuda nDoc gratuito (e de código aberto) que analisa todos os comentários em um projeto.

Answer 5

C# foi incorporado comandos de documentaçãoDivirta-se!

Answer 6

Sempre me disseram para usar comentários em bloco abertos com 2 ou mais asteriscos para delimitar comentários de documentação.

/**
Documentation goes here.
(flowerboxes optional) 
*/