c# - XML 注释 - MSDN 文档 "Note"部分——如何复制它？

Question

基本上，在 MSDN 联机帮助中，我经常遇到“注意”部分，但我终究无法弄清楚如何获得相同的输出。显然没有 <note>标签。有谁知道如何让它工作？

IDictionary(TKey, TValue) — 在此示例中，如果您转到备注部分，您就会明白我在说什么。

我正在使用 SandcaSTLe 帮助文件生成器。

Answer 1

实际上 SandcaSTLe 和 SandcaSTLe Help File Builder 都支持 <note>元素，尽管它隐藏得非常好! :-) 它只记录在我所知道的两个地方:

1. The XML Documentation Comments Guide 引用来自 Dyncity... 网络上显然不再可用——链接曾经是 http://www.dynicity.com/downloads/default.aspx .
2. A wallchart伴随着我在 Simple-Talk.com 上题为 Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code 的文章.请注意，文章中有一个指向挂图的链接，但它位于文章的最底部，因此我在此处提供了两者的链接。 (我在我的文章中也提到了 Dyncity 的指南；我将与编辑人员沟通，看看他们是否想托管现在已被孤立的 Dyncity 指南的本地副本，如果他们愿意，我会在此处发布更新。)<

这里是关于 <note> 的所有文档元素。 (这是我的挂图；Dyncity 指南基本上说了同样的话，但不那么简洁。)

令人遗憾的是，我所找到的关于 <note> 的所有文档都不充分.因此，我进行了一次快速试验，将每种笔记类型嵌入到一个备注部分。这是它产生的结果:

---

也就是说，用type="caution"你得到了警告图标和标签，而在我的特定示例中，其他两个类型属性值产生了相同的注释图标和标签。我怀疑它的其他用途可能深埋在灌木丛中。