misc.log

日常茶飯事とお仕事と

ドキュメントコメントでのコンストラクタへの参照

***依然調査中。以下の内容ではダメみたいです***


Visual Studio 2010では、標準でコメント文を元にヘルプファイルを作るネタとなるXMLファイルを生成する機能があります。このヘルプ用コメント文中で、他のメソッドやプロパティへの参照を作ることができるのですが、自分自身のコンストラクタへの参照の書き方が判らないので調べてみました。

''' <remarks>
''' アクセスする設定ファイルを設定、取得するプロパティです。設定ファイルへのアクセスは、このプロパティか
''' コンストラクタ<see cref="M:SettingManager.ctor(String)"/>で指定されたファイル名に直接アクセスするため、
''' 必ずフルパスもしくは相対パスでアクセス可能なファイル名を指定してください。
''' コンストラクタで設定ファイルが指定されていない場合、初期値は空文字列のままです。設定ファイルへの
''' アクセスメソッド呼び出し前までに設定ファイル名を設定してください。
''' </remarks>


こんな感じで「M:」に続けてクラス名を書き、コンストラクタを表す「ctor」、続いて引数を指定するなら型名列挙で記述すれば良いみたいです。かつて自分でもVisual Studio.NET 2003の頃、VBCommenterを使って行き詰まっていました。

[業務日誌.NET] VBCommenterによるコメント/コンストラクタへのsee cref記述
http://d.hatena.ne.jp/frontline/20051124/p3