使用 Sandcastle 记录：使用 <see> 引用枚举值答案

【问题标题】：Documenting using Sandcastle: Refering to enum value using <see>使用 Sandcastle 记录：使用 <see> 引用枚举值
【发布时间】：2010-05-01 14:38:32
【问题描述】：

我正在使用 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 页面也有一个 Page not found 链接。例如：UInt64.Parse Method (String, NumberStyles, IFormatProvider) 指代NumberStyles.AllowHexSpecifier，这会导致另一个MSDN Page not found。

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

我应该怎么做才能引用枚举？有没有可能？

【问题讨论】：

【解决方案1】：

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

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

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

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

【讨论】：

我在 SHFB 中找不到控制是否应创建指向不存在页面的链接的设置。我相信 Sandcastle 不知道 MSDN 不包含用于枚举值的单独页面这一事实。我可以链接到枚举页面中的特定枚举值吗？
我不知道...自从我使用 Sandcastle/SHFB 已经一年多了，我的记忆有点生疏了。据我记得，在 SHFB 界面中有很多开关可以使用，因此请多看几遍，看看是否有其他可以调整的东西来获得你想要的结果.抱歉，我无法提供比这更好的建议：\