我一直在尝试使用 XML 注释来完整记录类库的所有类型、方法、属性等,但遇到了涉及cref
属性的奇怪效果(see
例如,由标签使用)。按照这个 MSDN 页面的建议以及 MSDN 和其他网站上的各种其他示例,似乎每当使用cref
标签指定参考值时,它必须以某个标记为前缀,该标记对参考进行分类(例如 ' T:' 表示类型,'M:' 表示方法)。
但是,使用 Microsoft Sandcastle 时,我观察到缺少这些前缀会影响生成的文档(在这种情况下为 CHM 帮助文件)。包括前缀(在我相信的所有情况下),引用在页面上呈现为粗体文本......但不包括前缀,引用被呈现为 API 参考中相应页面的锚(链接)。对我来说似乎很奇怪,推荐的前缀(全部?)引用方法给出的结果最不有用 - 为什么引用在一种情况下呈现为粗体并在另一种情况下链接?如果有人能对此有所了解,我将不胜感激。