Fornecendo comentários de código XML
Comentários de código consultem comentários colocados em arquivos de código-fonte que estão disponíveis para usuários do ambiente de desenvolvimento integrado (IDE) através do recurso de IntelliSense.
[Visual Basic]
Comentários de código XML estão disponíveis em Visual Basic de por meio de ''' (três aspas simples) delimitador. For more information, see Como: criar documentação XML no Visual Basic.
[C#, J#]
Você pode usar o recurso de documentação XML para o código de comentário. Quando você anotar tipos e membros são definidos nos arquivos de origem de suas soluções com comentários de documentação XML, os comentários serão exibidos por meio de recursos de IntelliSense, como:
.gif "Observação") Observação |
|---|
Quando os comentários de métodos parciais, somente os comentários colocados na implementação, não a definição, aparecem na recursos de IntelliSense. |
For more information, see Comentários de documentação XML (Guia de programação C#).
[C++]
Por padrão, todos os comentários na fonte de código que usam o / / ou / * delimitadores são exibidas ao lado de seus membros associados da lista de membros. For more information, see C++ Comments and XML Documentation (Visual C++).
Ao rolar pela lista, o IntelliSense exibe até 12 linhas de comentário em uma janela pop-up ao lado para o membro realçado. Quando não existe mais de um comentário para uma função, IntelliSense determina qual comentário para exibir a lista de membros no qual ele aparece no código:
Primeiro, o IntelliSense exibe comentários de fim de linha na declaração. For example:
void MyFunction(); //EOL declaration commentsSe IntelliSense não encontrar o tipo anterior de comentário, ele exibe os comentários que aparecem diretamente acima da declaração sem linhas em branco entre. For example:
//Before declaration comments void MyFunction();Se os dois tipos de comentários anteriores não forem encontrados no código, o IntelliSense exibe os comentários de fim de linha na definição. For example:
int CMyAppDoc::MyVariable=2; // EOL definition commentsFinally, if none of the previous types of comments appear in the code, IntelliSense displays comments that appear directly above the definition with no blank lines in between. For example:
//Before definition comments CMyAppDoc::MyFunction() { return; }