web-dev-qa-db-ja.com

C＃ドキュメントタグとは何ですか？

C＃のドキュメントタグでは、MSDNと同様の出力を生成できます。クラス、メソッド、およびプロパティの上の///（トリプルスラッシュ）コメント領域内で使用できるタグのリストは何ですか？

c#xmldocumentation
34
Kevin Driedger

チェックアウト さまざまなC＃XMLドキュメンテーションタグに関する優れたドキュメンテーション （タグを表示するには下部に移動します）

9
David Mohundro

これをメソッドまたはクラスのすぐ上に入力すると、intellisenseは使用可能なタグのリストを表示する必要があります。

/// <
14
Joel Coehoorn

ここにリストがあります：

  • 概要
  • パラメータ
  • 戻り値
  • 例
  • コード
  • 見る
  • また見る
  • リスト
  • 値
  • ファイル
  • 著作権

次に例を示します。

 <file> 
 <copyright>（c）Extreme Designers Inc. 2008。</ copyright> 
 <datecreated> 2008-09-15 </ datecreated> 
 <summary> 
これが私の要約です
 </ summary> 
 <remarks> 
 <para> <see cref = "TextReader" />を使用できます</ para> 
 <list type = "number"> 
 <item>最初のアイテム</ item> 
 <item> 2番目のアイテム</ item> 
 </ list> 
 </ remarks> 
 <example> 
 <code> 
 System.Console.WriteLine（ "Hello、World" ）; 
 </ code> 
 </ example> 
 <param name = "aParam"> My first param </ param> 
 <returns>オブジェクト要約を表す</ returns> 
 </ file>
13
Kevin Driedger

すべてのタグとそれらをいつ使用するかを詳述した2002年のMSDN記事：

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

4
Ian Nelson

GhostDoc は、メソッド/クラスのスタブコメントを作成するのに役立ちます。

3
Forgotten Semicolon

最初のストップとして、優れたMSDN記事 here を参照してください。

2
Jesse C. Slicer

ドキュメント内で Sandcastle を探します。これは、.NETの新しいドキュメント標準です。

1
Scott Gowell