3

C# 仕様/StyleCop (どちらか不明) では、自動プロパティに 2 つのタグ --<summary>と<value>で注釈を付けることが提案されており、次のようになります。

class Foo
{
    /// <summary>Gets bar.</summary>
    /// <value>Bar.</value>
    public Example Bar { get; set; }
}

しかし、すべての実際的な目的のために、 の値<summary>は常にGets <whatever you said for value here\>.

ここにある個別のタグは、特定のドキュメント ジェネレーターを支援するためのものですか、それともコンパイラが自動プロパティを削除する方法と関係がありますか?

4

1 に答える 1

3

ご指摘のとおり、これら 2 つのタグの自動推奨コンテンツは冗長です。ただし、これら 2 つのタグに入れるテキストは、公開 API の一部など、十分に文書化されたクラスでは異なるものにする必要があります。

たとえば、DateTime.Date プロパティに関する Microsoft の公開 API ドキュメントを見てみましょう。

コメント内の と タグは、ドキュメントの 2 つの異なるセクションに対応しています<summary>。<value>この場合、ドキュメントは次のようなコメントから生成された可能性があります。

/// <summary>
///   Gets the date component of this instance.
/// </summary>
/// <value>
///   A new object with the same date as this instance, and the time value
///   set to 12:00:00 midnight (00:00:00).
/// </value>

したがって、ツールチップで使用される「概要」はプロパティの要約であり、「値」は返される値のより詳細な説明であることがわかります。

詳細については、 <summary>および<value>タグの完全なドキュメントを参照してください。

于 2013-01-14T11:29:51.527 に答える