it-swarm-pt.tech

Quais são as tags de documentação do C #?

Na documentação do C #, as tags permitem produzir uma saída semelhante ao MSDN. O que é uma lista de tags permitidas para uso dentro da área de comentário /// (barra tripla) acima das classes, métodos e propriedades?

34
Kevin Driedger
9
David Mohundro

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

/// <
14
Joel Coehoorn

Aqui está uma lista:

  • resumo
  • param
  • retorna
  • exemplo
  • código
  • vejo
  • veja também
  • lista
  • valor
  • arquivo
  • direito autoral

Aqui está um exemplo:

 <arquivo> 
 <copyright> (c) Extreme Designers Inc. 2008. </copyright> 
 <datecreated> 2008-09-15 </datecreated> 
 <summary> 
 Aqui está meu resumo 
 </summary> 
 <remarks> 
 <para> O <see cref = "TextReader" /> pode ser usado das seguintes maneiras: </para> 
 <list type = "number"> 
 <item> primeiro item </item> 
 <item> segundo item </item> 
 </list> 
 </remarks> 
 <exemplo> 
 <code> 
 System.Console.WriteLine ("Olá, mundo" ); 
 </code> 
 </example> 
 <param name = "aParam"> Meu primeiro parâmetro </param> 
 <retorna> um objeto que representa um resumo </returns> 
 </file> 
13
Kevin Driedger

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

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

4
Ian Nelson

GhostDoc ajuda criando um comentário sobre o seu método/classe.

3
Forgotten Semicolon

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

2
Jesse C. Slicer

Procure nos documentos por Sandcastle . Este é o novo padrão de documentação para .NET.

1
Scott Gowell