2

C# のドキュメント標準を調べ始めたところです。これが私が持っている方法です：

/// <summary>
/// Reformats a key in x.x format to 0x0x format
/// </summary>
/// <param name="dotFormatRowKey">key in ##.## format</param>
public static string DotFormatToRowKey(this string dotFormatRowKey) 
{

    if (! Regex.IsMatch(dotFormatRowKey, @"\d+\.\d+"))
       throw new ArgumentException("Expected ##.##, was " + dotFormatRowKey);

    var splits = dotFormatRowKey.Split('.')
                 .Select(x => String.Format("{0:d2}", Int32.Parse(x)))
                 .ToList();
    var joined = String.Join(String.Empty, splits.ToArray())

    return joined;
}

このメソッドの入力パラメーターと戻りパラメーターをどのように文書化するべきかについて、誰かがアドバイスをくれますか? また、これを行うと、VS2010 インテリセンスを使用している場合、文書化されたコメントを利用できますか?

4

1 に答える 1

1

パラメータをどのように文書化する必要があるかについては、かなり主観的だと思いますが、あなたが行った方法は私には問題ないように見えます. joinedまた、戻り変数をより詳細なものに変更することもできます"keyFormattedString"。

あなたの質問の2番目の部分については：

また、これを行うと、VS2010 インテリセンスを使用している場合、文書化されたコメントを利用できますか?

msdn からの引用:

拡張メソッドは、using ディレクティブを使用して名前空間をソース コードに明示的にインポートする場合にのみ有効です。

メソッドがクラス ライブラリ内のクラス内にある場合、メソッドとドキュメント化されたコメントを使用/表示するには、そのライブラリを現在のソリューションで参照する必要があります。基本的に、すべての拡張メソッドを含む新しいクラス ライブラリを作成し、その DLL を作業中のソリューションにインポートできます。

クラス ライブラリがあり、単純に追加するとします。

using ExtensionMethodsLib; // or whatever you'll call it

必要なページの using ステートメントに。

拡張メソッド (msdn)

于 2012-09-22T14:11:52.067 に答える