使用Sandcastle进行记录:使用<see>参考枚举值

bri*_*ner 6 c# sandcastle msdn enums xml-documentation

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

在我的文档中,我正在使用<see>标签.

如果我尝试将枚举称为<see cref="NumberStyles"/>完美无缺.

如果我尝试引用枚举值,就像<see cref="NumberStyles.AllowTrailingWhite"/>我在文档文件中得到一个链接,但链接导致我找不到MSDN页面

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

我注意到引用枚举值的MSDN页面也有一个找不到页面的链接.例如:UInt64.Parse方法(String,NumberStyles,IFormatProvider)引用NumberStyles.AllowHexSpecifier,这导致找不到另一个MSDN页面.

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

我该怎么做才能引用枚举?它甚至可能吗?

Dan*_*fer 2

MSDN 上发生的事实并不是一个好兆头。枚举值有 XML 文档吗?

如果我没记错的话,SHFB 中应该有一些设置可以让您强制为没有 XML 的成员生成文档 - 或者也许这是一个可以让您排除没有 XML 文档的成员的设置。无论如何,请仔细检查一下设置,以确保您不会以这种方式排除枚举成员。

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

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