2013年7月8日月曜日

【XMLドキュメントコメント】の書き方


XMLドキュメントコメントに<see cref="メッソッド名"/>を書く際の注意点です。
以下のサイトに詳しい説明がありますが、簡単な部分を補足します。

http://smdn.jp/programming/netfx/classlibrary/2_xmldoccomments/
http://msdn.microsoft.com/ja-jp/library/fsbx0t7x.aspx

同一クラス内の参照

単純にメッソッド名だけ指定すればよい
  <see cref="メッソッド名"/>
  引数は不要(引数が必要な場合は他クラスからの参照と同じ書式になる。)
  


他クラスからの参照

同一クラスは単純ですが、他クラスのメッソッドの場合は以下の指定が必要になります。
  <see cref="記号:ネームスペース.クラス名.メッソッド名(引数)"/>
 

記号
 T   class、interface、struct、enum、delegate
 F   field
 P   プロパティ
 M  メソッド (コンストラクター、演算子などの特殊なメソッドを含む)

メソッド名
 
 
基本的にメソッド名でOKです。
ただし、コンストラクタのメッソッド名は次のように「#ctor」になります。
 クラス名.#ctor
他に演算子等も指定方法が異なります。

引数
 型は.NET Framework 型で表現する必要があります。
 独自の型の場合もネームスペース.クラス名とする必要があります。
 型の指定のみで変数名は不要です。
 引数と引数の間にスペースを入れない。例(System.Int32,System.Int32)
 参照型(ref)の場合は型の後ろにアットマークを付ける。 例(System.Int32@)

 float     System.Single
 int   System.Int32
 uint  System.UInt32
 string System.String
 long  System.Int64
 ulong System.UInt64
 decimal System.Decimal
 double  System.Double
 int?  System.Nullable{System.Int32}

namespace N
{
    public class X
    {
        /// <summary>
        ///<see cref="M:N.X.#ctor(System.String,System.Int32@)"/>
        /// </summary>
        public X(string s, ref int y) { }
    }
}

0 件のコメント:

コメントを投稿