Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
O uso de comentários de XML doc requer delimitadores, que indicam ao compilador onde um comentário de documentação começa e termina.Você pode usar os seguintes tipos de delimitadores com as Rótulos de documentação XML:
///
Isso é o formulário que é mostrado nos exemplos de documentação e usado pelos modelos de projeto do Visual translation from VPE for Csharp..gif "Observação")
Observação:O IDE do Visual Studio possui um recurso chamado Smart comentário edição que insere as Rótulos <resumo>e</resumo> automaticamente e move o cursor dentro dessas Rótulos após digitar o /// delimitador no Editor de código. Para acessar este recurso do Formatação, C#, editor de texto, caixa de diálogo Opções em suas páginas de propriedade do projeto.
/** */
Delimitadores de várias linhas.
Existem algumas regras de formatação ao usar o /** */ delimitadores:
A linha que contém o /** delimitador, se o restante da linha é o espaço em branco, a linha não é processada para comentários. Se o primeiro caractere estiver em branco, esse caractere de espaço em branco será ignorado e o restante da linha é processado.Caso contrário, todo o texto da linha após o /** delimitador é processado sistema autônomo parte do comentário.
A linha que contém o */ delimitador, se houver somente espaços em branco até o */ delimitador, essa linha é ignorado. Caso contrário, o texto da linha até o */ delimitador é processado sistema autônomo parte do comentário, sujeito às regras de correspondência de padrões descritas no seguinte marcador.
Para as linhas depois que começa com o /** delimitador, o compilador procura um padrão comum no início de cada linha consiste em espaço em branco opcional e um asterisco (*), seguido de mais espaço em branco opcional. Se o compilador encontra um conjunto comum de caracteres no início de cada linha, ele irá ignorar esse padrão para todas as linhas após a /** delimitador, até e possivelmente incluindo a linha que contém o */ delimitador.
Alguns exemplos:
A única parte do seguinte comentário será processado é a linha que começa com <summary>. Os seguintes formatos de duas marca produzirá os mesmos comentários:
/**
<summary>text</summary>
*/
/** <summary>text</summary> */
O compilador aplica um padrão de "*" para ignorar no início da segunda e terceira linhas.
/**
* <summary>
* text </summary>*/
O compilador não localizará nenhum padrão este comentário porque não há nenhum asterisco na segunda linha.Portanto, todo o texto sistema autônomo linhas da segunda e terceira, até o */, será processado sistema autônomo parte do comentário.
/**
* <summary>
text </summary>*/
O compilador não encontra nenhum padrão neste comentário por dois motivos.Primeiro, não há nenhuma linha que começa com o número de espaços antes do asterisco consistente.Em segundo lugar, a quinta linha começa com uma guia, que não coincide com espaços.Portanto, todo o texto da linha de segundo até o */ será processado sistema autônomo parte do comentário.
/**
* <summary>
* text
* text2
* </summary>
*/
Consulte também
Tarefas
Conceitos
Referência
Comentários de documentação XML (Guia de programação C#)
/doc (processo Documentação Comments) (opções do compilador de C#)