许多常量的 XML 文档答案

【问题标题】：XML Documentation for many Constants许多常量的 XML 文档
【发布时间】：2012-12-21 14:13:28
【问题描述】：

有没有办法将 XML 文档 summary 标签与类中的常量放在同一行？

我有一个定义了许多常量返回值的类，并且在每个类之间都有注释行，这使得阅读和维护有点困难。（同样的问题也适用于枚举值。）

下面的代码显示了我的代码现在的样子。如果有办法，我想保持这种状态。

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/ 来生成我的文档。

谢谢！

【问题讨论】：

在每个常量上方使用 XML cmets；它们是智能感知的，您可以在自动化文档工具（包括 Sandcastle）中使用它们。 VS、Sandcastle 和 intellisense 都希望 cmets 高于它们所指的元素。
是的，我就是这样做的，但我特别想问是否有人知道在同一条线上的方法。一旦你有很多常量，无论它们是字符串还是数值，列表就会变得难以通过它们之间的 cmets 来维护。
不破坏我提到的工具。如果常量的数量太繁重，请将常量放入自己的类中。
看起来应该是enum，而不是带有常量的类。

标签： c# documentation sandcastle

【解决方案1】：

不，我认为您必须将 XML 文档包含在它所记录的内容之上。但是，您可以将摘要标签及其内容放在一行中：

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

【讨论】：