Fornecendo comentários do código XML

  • Artigo

Comentários do código consultem comentários colocados em arquivos de código-fonte estão disponível para usuários do ambiente de desenvolvimento integrado (IDE) através do recurso IntelliSense.

[Visual Basic]

Comentários de código XML estão disponível no Visual Basic através de ''' delimitador (três aspas simples). Para obter mais informações, consulte Como: Criar documentação XML no Visual Basic.

[J# TRANSLATION FROM VPE FOR CSHARP]

Você pode usar o recurso de documentação XML para o código de comentário.Quando anotar tipos e membros que são definidos em arquivos de fonte de suas soluções com comentários de documentação XML, esses comentários serão exibidos por meio de recursos do IntelliSense, sistema autônomo:

Observação:

Quando os comentários métodos parcial, somente os comentários posicionados na implementação, não definição, aparecem em recursos do IntelliSense.

Para obter mais informações, consulte Comentários de documentação XML (Guia de programação C#).

[C++]

Por padrão, os comentários na fonte de código que usam o / / ou / * delimitadores são exibidos ao lado de seu membro associado na lista de membros.Para obter mais informações, consulte Comentários C++ e Documentação XML (Visual C++).

À medida que rolar pela lista, o IntelliSense exibe linhas até 12 do comentário em uma janela pop-up ao lado para o membro realçado.Quando houver mais de um comentário para uma função, o IntelliSense determina qual comentário para exibir em lista de membros, onde ela aparece no código:

  1. Primeiro o IntelliSense exibe comentários de participante-of-linha na declaração.Por exemplo:

    void MyFunction();   //EOL declaration comments

  2. Se o IntelliSense não encontrar o tipo de comentário anterior, ele exibe comentários que aparecem diretamente acima da declaração com há linhas em branco entre.Por exemplo:

    //Before declaration comments
   void MyFunction();

  3. Se não forem localizados anteriores dois tipos de comentários no código, o IntelliSense exibe comentários de participante-of-linha na definição.Por exemplo:

    int CMyAppDoc::MyVariable=2; // EOL definition comments

  4. Finalmente, se nenhum dos tipos anteriores de comentários aparecer no código, o IntelliSense exibe comentários que aparecem entre diretamente acima da definição com há linhas em branco.Por exemplo:

    //Before definition comments
CMyAppDoc::MyFunction() 
{
   return; 
}

Consulte também

Referência

Listar Membros

Outros recursos

Usando o IntelliSense