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 文档包含在它所记录的内容之上。但是，您可以将摘要标签及其内容放在一行中：

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