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

时间:2010-05-01 14:38:32

标签: c# enums msdn sandcastle xml-documentation

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

在我的文档中,我使用的是<see>代码。

如果我尝试引用类似<see cref="NumberStyles"/>的枚举,则效果非常好。

如果我尝试引用类似<see cref="NumberStyles.AllowTrailingWhite"/>的枚举值,我会在文档文件中找到一个链接,但该链接会将我引导至MSDN Page not found

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

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

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

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

1 个答案:

答案 0 :(得分:2)

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

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

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

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