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

No Visual C# você pode criar documentação para o seu código, incluindo as tags XML nos campos de comentário especial 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ê compila com /doc o compilador irá procurar por todas as marcas XML na fonte de código e criar um arquivo de documentação XML.Para criar a documentação final com base no arquivo gerado pelo compilador, você pode criar uma ferramenta personalizada ou usar uma ferramenta como Sandcastle.

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 marcas para comentários da documentação

• Processando o Arquivo XML

• Delimitadores de marcas de documentação

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

Seções relacionadas

Para obter mais informações, consulte:

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

Especificação da linguagem C#

Para obter mais informações, consulte Especificação de linguagem do C# A especificação da linguagem é a fonte definitiva para a sintaxe e o uso da linguagem C#.

Consulte também

Conceitos

Guia de programação do C#