.NET XML文档中的参考前缀

我一直在尝试使用XML注释完全记录类库的所有类型,方法,属性等,但却遇到了涉及cref属性的奇怪效果(例如, see标记)。 按照这个MSDN页面的建议以及MSDN和其他网站上的各种其他示例,似乎每当使用cref标签指定参考值时,它都必须以特定的标记作为前缀,这些标记会对refence进行分类(例如'T:'表示类型,'M:'表示方法)。

然而,使用微软Sandcastle,我发现通过错过这些前缀,在生成的文档(在这种情况下是CHM帮助文件)中有效果。 包括前缀(在所有情况下,我相信),引用在页面上呈现为粗体文本...然而,排除前缀引用被呈现为API参考内的适当页面的锚点(链接)。 对我来说,似乎相当奇怪的是,推荐的前缀引用(all?)引用的方法是给出最少的有用结果 - 为什么引用应该在一种情况下呈现为粗体而在另一种情况下被链接? 如果有人能够阐明这一点,我将不胜感激。


这似乎是沙堡中的一个错误

你正在使用什么版本的沙堡?

也就是说最近的讨论似乎表明,至少对于系统类型来说,建议的方法实际上是避免使用限定名称,因为在该答案中设置的示例将T:和M全部删除:因此,您的混淆并非意外或不常见。

本文档强烈暗示编译器可以找到指向要插入前缀的类型/方法/常量。 你有没有在xml中验证过这个?

链接地址: http://www.djcxy.com/p/85309.html

上一篇: Reference Prefixes in .NET XML Documentation

下一篇: Naming convention (Singular or plural name class)