菊池 Blog

移転しました 続・菊池 和彦の足跡

AILight Banner
AILight Blog

プロフィール

菊池 Blog

目次

Blog 利用状況

記事分類

過去の記事

タグ

ドキュメントコメントで true / false / nullの表現

リファレンス見ても見当たらないんだけど。

こういう言語的なキーワードされてる定数ってドキュメントコメントではどう書くんでしょうか。

True / False / Nothingな人にも優しいドキュメントでありたいと思ったけどどう書くのが正しいのでしょう。

 

/// <summary>コンテナから<paramref name="Name"/>で示される値を取得します。</summary>
/// <returns>
/// <para>コンテナにコレクションが無い場合 false を返します。コレクションがあってもコレクション内に指定の値が無い場合も false を返します。</para>
/// <para>falseが返される場合には<paramref Name="Value/>は必ず null となります。</para>
/// <para>値が取得できた場合には<paramref Name="Value"/> に値が設定され true を返します。</para>
/// </returns>
/// <remarks>コンテナは値としてnullを格納することがあります。この場合、戻り値としてtrueが返されても<paramref name="Value">にはnullが返されます。</remarks>
bool TryGetValue( string Name ,out object Value)

こんなコメント、ソース上で書きたくないっていうのは自分の怠慢だと思うんだけど、読みづらいと思うのは自分だけ?(ましてや、ソース上で邪魔って思う自分が居たりする)

 

投稿日時 : 2007年12月9日 6:55


コメントを追加

タイトル
名前
URL
コメント