.NET XML 文档中的参考前缀

Question

我一直在尝试完整记录所有类型、方法、属性等。使用 XML 注释的类库，但遇到了一个奇怪的效果，涉及 cref 属性（由 see 例如标签）。遵循以下建议 这个 MSDN 页面 以及遵循 MSDN 和其他网站上的各种其他示例，似乎每当人们使用 cref 标签，它必须以对引用进行分类的特定标记为前缀（例如用于类型的“T：”和用于方法的“M：”）。

然而，使用 Microsoft Sandcastle，我发现如果忽略这些前缀，则会对生成的文档（本例中为 CHM 帮助文件）产生影响。包括前缀（在我相信的所有情况下），引用在页面上呈现为粗体文本......然而，除了前缀之外，引用将呈现为 API 引用中相应页面的锚点（链接）。对我来说，推荐的给（全部？）引用添加前缀的方法给出了最无用的结果——为什么引用应该在一种情况下呈现为粗体并在另一种情况下链接？如果有人能阐明这一点，我将不胜感激。

Answer 1

这似乎是一个 沙堡里的虫子

您使用什么版本的沙堡？

那就是说 最近的讨论 似乎表明，至少对于系统类型，建议的方法是实际上避免使用限定名称，因为该答案中提出的示例删除了 T：和中号：因此，您的困惑并不意外或不常见。

本文档 强烈暗示编译器可以识别您指向的类型/方法/常量，并为您插入前缀。你在xml中验证过这一点吗？