XML ドキュメント コメント

概要

名前空間の概要コメント

ECMA-334SHFBDoxygen
不可 ・特殊クラス NamespaceDocに <summary> 指定
・設定で指定
namespaceに <summary> 指定

タグ 一覧

タグ備考配置サポート
ルート子ECMA-334SHFBDoxygen
<AttachedEventComments> WPF ルーティングイベント ◎●
<AttachedPropertyComments> WPF 添付プロパティ ◎●
<c>コード (インライン) ●●●●
<code>コード (行ブロック) ●●●●
<conceptualLink> MAML(拡張XML) トピック リンク ●●●
<description>リスト・表の説明 <list>●●●
<event> 発生イベント ●●
<example>使用例 ●●●
<exception>例外 ●●●●
<exclude> 出力除外 ●●
<filterpriority> VB用 IntelliSense 制御 ●●
<include>外部XMLコメント挿入 ●●●●
<inheritdoc> ドキュメント継承 ◎●●●
<item>リスト・表のデータ部 <list>●●●
<list>リスト・表
・箇条書きリスト
・番号付きリスト
・定義表
・表
●●●●
<listheader>表のヘッダ部 <list>●●●
<note> メモ ●●
<overloads> オーバーロード ◎●
<para>段落 ●●●●
<param>メソッド パラメータ ●●●●
<paramref>パラメータ参照 (インライン) ●●●●
<permission> アクセス権 ●●●
<preliminary> 暫定 ●●
<remarks>備考 ●●●●
<returns>戻り値 ●●●●
<revision> 改訂項目 <revisionHistory>●
<revisionHistory> 改訂履歴 ●●
<see>参照 (インライン) ●●●●
<seealso>参照 ●●●●
<summary>概要 ●●●●
<term>リスト・表の定義 <list>●●●
<threadsafety> スレッドセーフ ●●
<token> トークン (置換) ●●●
<typeparam>ジェネリック型パラメータ ●●●●
<typeparamref>ジェネリック型パラメータ参照 (インライン) ●●●●
<value>プロパティ値 ●●●

項目記号備考
全般●有効
ルート◎他のルート要素を含む
子<~><~> の子要素

対象
ECMA-334 (5th 2017/12)
SHFB (v2018.5.29.0)
Doxygen (1.8.14 2017/12/25)

外部リンク