.NET XML文档中的参考前缀

时间:2009-04-22 19:57:14

标签: .net documentation xml-comments xml-documentation

我一直在尝试使用XML注释完整地记录类库的所有类型,方法,属性等,但是遇到了涉及cref属性的奇怪效果(由see使用标签例如)。根据{{​​3}}的建议以及MSDN和其他网站上的各种其他示例,似乎每当使用cref标记指定参考值时,它必须以某个标记为前缀对refence进行分类(例如'T:'表示类型,'M:'表示方法)。

然而,使用Microsoft Sandcastle,我发现通过错过这些前缀会对生成的文档产生影响(在本例中为CHM帮助文件)。包括前缀(在我认为的所有情况下),引用在页面上呈现为粗体文本...但是,在引用中,引用被呈现为API引用中的适当页面的锚点(链接)。对我来说似乎很奇怪,推荐的前缀(所有?)引用的方法给出了最不实用的结果 - 为什么引用在一种情况下呈现为粗体并在另一种情况下链接?如果有人能对此有所了解,我将不胜感激。

1 个答案:

答案 0 :(得分:2)

这似乎是bug in sandcastle

您使用的是什么版本的沙堡?

那说recent discussions似乎表明,至少对于System类型,建议的方法是实际上避免使用限定名称,因为在该答案中提出的例子放弃了T:和M:完全你的困惑是因此不出意外或不常见。

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