使用Sandcastle进行文档编写：使用<see>引用枚举值

Question

使用Sandcastle进行文档编写：使用<see>引用枚举值

c#enumsmsdnsandcastlexml-documentation

6

我正在使用Sandcastle 2.4.10520和Sandcastle Help File Builder 1.8.0生成.chm帮助文件。

在我的文档中，我正在使用标签。

如果我尝试引用枚举，如，它可以完美地工作。

如果我尝试引用枚举值，如，我会在文档文件中得到一个链接，但该链接将导致MSDN页面未找到。

我没有收到任何警告-我的xml文档正确。

我注意到MSDN页面在引用枚举值时也会有一个“页面未找到”链接。例如: UInt64.Parse Method (String, NumberStyles, IFormatProvider) 引用了 NumberStyles.AllowHexSpecifier，这会导致另一个 MSDN Page not found。我应该引用枚举而不是枚举值吗？如何引用枚举？这是否可能？

- brickner

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Daniel Schaffer · Accepted Answer

“它正在MSDN上发生并不是一个好兆头。这些枚举值有XML文档吗？”

“如果我没记错的话，SHFB应该有一些设置可以让你强制生成没有XML文档的成员的文档，或者可能有一个设置可以让你排除没有XML文档的成员。无论如何，请仔细检查设置，确保你没有以这种方式排除枚举成员。”

“否则，它应该为每个成员生成文档，而枚举值是类型的成员，就像常量或静态字段一样。”

“编辑：看起来至少在新的MSDN网站上，单独的枚举值没有自己的页面。例如，看看NumberStyles枚举。在这种情况下，你可能没有比链接到枚举更好的选择。”