c# - 使用 SandcaSTLe : Refering to enum value using <see> 记录

Question

我正在使用 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 .

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

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

Answer 1

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

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

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

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