Comentários de documentação XML (Guia de programação C#)

No Visual translation from VPE for Csharp você pode criar documentação para o seu código, incluindo as Rótulos XML em campos de comentários especiais no código-fonte antes do bloco de código que se referem.Por exemplo:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

Quando você compilar com /doc o compilador irá procurar por todas as Rótulos XML no código-fonte e criar um arquivo de documentação XML.

Observação:
Os comentários doc XML não são metadados; eles não são incluídos no assembly compilado e, portanto, não são acessíveis através de reflexão.

Nesta seção

• Recomendado Rótulos para comentários de documentação

• Processando o Arquivo XML

• Delimitadores de Rótulos de documentação

• Como: Use os recursos de documentação XML

Seções relacionadas

Para obter mais informações, consulte:

• /doc (comentários de documentação do processo)

• Exemplo de documentação XML

Especificação da linguagem C#

Para obter mais informações, consulte as seções a seguir no Especificação da linguagem C#:

• Apêndice A comentários de documentação

Consulte também

Conceitos

Guia de Programação C#