c# - 多くの定数の XML ドキュメント

Question

クラスの定数と同じ行に XML ドキュメントの要約タグを配置する方法はありますか?

多くの定数の戻り値が定義されたクラスがあり、それぞれの間にコメント行があると、読み取りと保守が少し難しくなります。(これと同じ質問が列挙値にも当てはまります。)

以下のコードは、私のコードが現在どのように見えるかの例を示しています。方法があればこのままにしておきたいです。

public class MyUtilClass
{
    public static int  UTIL_SUCCESS         = 0;   // This is an example comment for success.
    public static int  UTIL_WARNING_LEVEL_1 = 1;   // This is an example comment for warning level 1.
    public static int  UTIL_WARNING_LEVEL_2 = 2;   // This is an example comment for warning level 2.
    public static int  UTIL_FAILED          = 3;   // This is an example comment for failure.
}

http://shfb.codeplex.com/を使用してドキュメントを生成しています。

ありがとう！

Answer 1

いいえ、文書化するものの上にXMLドキュメントを含める必要があると思います。ただし、サマリータグとそのコンテンツを1行に含めることができます。

/// <summary>Some content</summary>
public static int  UTIL_SUCCESS         = 0;