代码之家  ›  专栏  ›  技术社区  ›  Noldorin

.NET XML文档中的引用前缀

  •  2
  • Noldorin  · 技术社区  · 15 年前

    我一直在尝试使用XML注释完整地记录类库的所有类型、方法、属性等,但是遇到了一个奇怪的效果,涉及到 cref 属性(由使用 see 例如标签)。听从…的建议 this MSDN page 除了遵循msdn和其他网站上的各种其他示例外,似乎每当使用 克里夫 标记,它必须以某个对引用进行分类的标记作为前缀(例如,对于类型为“t”,对于方法为“m”)。

    然而,使用Microsoft Sandcastle,我注意到,通过省略这些前缀,在生成的文档(本例中是chm帮助文件)中会产生影响。包括前缀(在我相信的所有情况下),引用在页面上呈现为粗体文本…然而,如果不使用前缀,则引用将作为锚(链接)呈现给API引用中的适当页面。我觉得很奇怪,推荐的预混方法(全部?)引用给出的结果是最不有用的——为什么在一种情况下引用应呈现为粗体并在另一种情况下链接?如果有人能对这件事有所了解,我将不胜感激。

    1 回复  |  直到 15 年前
        1
  •  2
  •   ShuggyCoUk    15 年前

    这似乎是一个 bug in sandcastle

    你用的是什么版本的沙堡?

    那说 recent discussions 似乎表明,至少对于系统类型而言,建议的方法是实际避免使用限定名,因为该答案中的示例删除了t:和m:这一点,因此您的混淆并不意外或不常见。

    This documentation 这意味着编译器可以在其中发现您要指向的类型/方法/常量,并为您插入前缀。您在XML中验证过这个吗?

    推荐文章