6

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

在我的文档中，我使用了<see>标签。

如果我尝试引用一个枚举，<see cref="NumberStyles"/>它就可以完美地工作。

如果我尝试引用一个枚举值，例如<see cref="NumberStyles.AllowTrailingWhite"/>在文档文件中获得一个链接，但该链接将我引导至未找到的 MSDN 页面

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

我注意到引用枚举值的 MSDN 页面也有一个 Page not found 链接。例如：UInt64.Parse Method (String, NumberStyles, IFormatProvider)引用NumberStyles.AllowHexSpecifier，这会导致另一个MSDN Page not found。

我应该引用枚举而不是枚举值吗？

我应该怎么做才能引用枚举？甚至可能吗？

4

1 回答 1

2

它发生在 MSDN 上的事实并不是好兆头。枚举值是否有 XML 文档？

如果我没记错的话，SHFB 中应该有一些设置可以让你强制为没有 XML 的成员生成文档 - 或者它可能是一个让你排除没有 XML 文档的成员的设置。无论如何，请重新设置好一次，以确保您不会以这种方式排除枚举成员。

否则，它应该为每个成员生成文档，并且枚举值是与 const 或静态字段相同的类型的成员。

编辑：看起来至少在较新的 MSDN 站点上，单个枚举值没有给出自己的页面。例如，看一下NumberStyles枚举。在这种情况下，您可能没有比仅链接到枚举更好的选择。

于 2010-05-01T14:46:44.700 回答