3

c# のクラスのパラメーターと Func プロパティの戻り値を文書化するための推奨される方法は何ですか?

public class Test
{
    /// <summary>
    /// A description of what AFunc is for.
    /// </summary>
    /// <remarks>
    /// Should I document the parameters and return here or somewhere else?
    /// </remarks>
    public Func<object, string[], bool> AFunc { get; set; }
}

Visual Studio 2010 の Intellisense は、メソッドの場合のように、プロパティの param または return タグを提供しません。それでも、それらは使用するのに最も適切なタグでしょうか?

編集：

これを尋ねて以来、msdn の xml ドキュメントのいくつかで、有効な xml をタグ付けに使用できることを発見しました。またはカスタムタグを使用して適切な命名を決定しますか?

4

2 に答える 2

4

コードのドキュメントに依存するのではなく、コードをより「エンド開発者」にとって使いやすいものにすることから始めることをお勧めします。戻り値の型をわかりやすい名前のデリゲートに変更することを検討してください。

http://msdn.microsoft.com/en-us/library/ms173171(v=vs.100).aspx

まず、これにより、コードがより自明になります。その後、戻り値の型を説明しようとするのではなく、コード ドキュメントを使用して戻り値の目的を説明できます。

于 2012-07-14T08:16:39.873 に答える
0

プロパティはパラメーターを取らないため、param を使用しませんtypeparam。ジェネリック パラメーターに使用する必要があります。の代わりにreturns、 を使用しますvalue。

于 2012-07-14T08:11:26.147 に答える