XML注释 - MSDN文档"注意"部分 - 如何复制此内容?

m-y*_*m-y 5 c# sandcastle msdn xml-comments

基本上,在MSDN在线帮助中我经常遇到一个"注意"部分,但不能为我的生活弄清楚如何获得相同的输出.显然没有<note>标签.有谁知道如何使这个工作?

IDictionary(TKey,TValue) - 在这个例子中,如果你转到备注部分,你会看到我在说什么.

我正在使用Sandcastle帮助文件生成器.

Mic*_*ens 6

实际上,Sandcastle和Sandcastle帮助文件生成器都支持一个<note>元素,尽管它非常隐蔽!:-)它只记录在我所知道的两个地方:

  1. 来自Dyncity 的XML文档评论指南参考文献...显然已不再可在网上获得 - 链接曾是http://www.dynicity.com/downloads/default.aspx.
  2. 一个挂图伴随我的Simple-Talk.com题为的文章驯服沙堡:一个.NET程序员指南代码文档.请注意,文章中有一个链接可以访问挂图,但它位于文章的最底部,所以我在这里给出了两个链接.(我在文章中也提到了Dyncity的指南;我将与编辑人员沟通,看看他们是否想要托管当前孤立的Dyncity指南的本地副本,如果他们这样做,可以在此发布更新.)

这是关于<note>元素的所有文档.(这是我的挂图; Dyncity指南说的基本上是相同的,但简洁得多.)

音符元素的语法

令人遗憾的是,我所发现的所有文件都不充分<note>.所以我进行了快速试用,将每个笔记类型嵌入到备注部分.这是它产生的:


样本Sandcastle注意输出

也就是说,在type="caution"您获得警告图标和标签的同时,其他两个类型属性值在我的特定示例中生成相同的注释图标和标签.我怀疑它的使用可能还有其他方面深埋在灌木丛中.