Pergunta

Na documentação do C#, as tags permitem produzir resultados semelhantes ao MSDN.Qual é a lista de tags permitidas para uso dentro da área de comentários /// (barra tripla) acima de classes, métodos e propriedades?

Foi útil?

Solução

Outras dicas

Se você digitar isso logo acima de um método ou classe, o intellisense deverá solicitar uma lista de tags disponíveis:

/// <

Aqui está uma lista:

  • resumo
  • parâmetro
  • retorna
  • exemplo
  • código
  • ver
  • Veja também
  • lista
  • valor
  • arquivo
  • direito autoral

Aqui está um exemplo:

<file>
<copyright>(c) Extreme Designers Inc. 2008.</copyright>
<datecreated>2008-09-15</datecreated>
<summary>
Here's my summary
</summary>
<remarks>
<para>The <see cref="TextReader"/> can be used in the following ways:</para>
<list type="number">
<item>first item</item>
<item>second item</item>
</list>
</remarks>
<example>
<code>
System.Console.WriteLine("Hello, World");
</code>
</example>
<param name="aParam">My first param</param>
<returns>an object that represents a summary</returns>
</file>

Artigo do MSDN de 2002 detalhando todas as tags e quando usá-las:

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

GhostDoc ajuda criando um esboço de comentário para seu método/classe.

Veja o excelente artigo do MSDN aqui como sua primeira parada.

Procure dentro dos documentos para Castelo de Areia.Este é o novo padrão de documentação para .NET.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top