XML ドキュメント コメント

提供: Appmethod Topics
移動先: 案内検索

コード エディタ への移動


概要

XML ドキュメント コメントの特徴は以下のとおりです。

  • 3 重スラッシュ(///)で始まる。
  • XML タグを使って構造化されている。
  • 通常のコード ブロックやコード領域のように折りたたまれる、または展開される(「コードを折りたたむ」を参照)。
  • Object Pascal でサポートされている。

XML ドキュメント コメントはヘルプ インサイトに表示されます(正常に解析された場合)。また、XML ドキュメントを生成するときにコンパイラによってインクルードされます(devnotes XML 要素と同様)。

XML タグは、<para>...</para> のように、適切に閉じていなければなりません。閉じる側の要素が見つからない場合、その XML 表現は無効になるため、ヘルプ インサイトにその XML コメントを表示できません。

XML ドキュメント コメントの付いた Object Pascal 関数の例

 /// <summary> Removes the specified item from the collection
 /// </summary>
 /// <param name="Item">The item to remove
 /// </param>
 /// <param name="Collection">The group containing the item
 /// </param>
 /// <remarks>
 /// If parameter "Item" is null, an exception is raised.
 /// <see cref="EArgumentNilException" />
 /// </remarks>
 /// <returns>True if the specified item is successfully removed;
 /// otherwise False is returned.
 /// </returns>
 function RemoveItem(Item: Pointer; Collection: Pointer): Boolean;
 begin
   // Non-XML DOC comment
   // ...
 end;

XML ドキュメント コメントの例は、以下のソース ファイルを参照してください。

  • DSServer.pas
  • DSCommonServer.pas
  • DSHTTP.pas

XML 要素

XML ドキュメント コメントでは以下の要素を使用できます。

<summary>

対象となる関数またはクラスの要約です。

<para>

段落

<c>

等幅フォントのテキスト

<code>

ソースコードなどの整形済みテキスト

<remarks>

対象となる関数またはクラスに関する備考です。

<param name="パラメータ名">

特定のパラメータの名前と説明です。

<see>

特定の型、シンボル、識別子への参照です。

<returns>

対象となる関数の戻り値の説明です。たとえば、関数がエラー コードを返す場合もあるでしょう。

<exception cref="例外の種類の名前">

メソッドによって送出される例外

<permission cref="権限の種類">

メソッドの権限

関連項目