C＃xml文档：如何创建Notes？

Question

我希望在我自己的文档中this MSDN page的备注部分中找到与黄色'注意：'框类似的内容。

我正在使用sandcastle和sandcastle帮助文件构建器从文档标记中生成参考网站。为了获得这样的便签盒，我需要写些什么？

Answer 1

/// <summary><c>Increment</c> method increments the stored number by one. 
/// <note type="caution">
/// note description here
/// </note>
/// </summary>   

查看文件“C：\ Program Files \ Sandcastle \ Examples \ Sandcastle \ test.cs”

类型可以是以下之一：

• 注释
• 尖
• 警告
• 安全
• 重要
• vb / VB / VisualBasic / visual basic note
• cs / CSharp / c＃/ C＃/ visual c＃note
• cpp / c ++ / C ++ / CPP / visual c ++ note
• JSharp / j＃/ J＃/ visual j＃note
• 实施
• 呼叫者
• 继承

Answer 2

不是直接解决方案，而是替代方案：

NDoc支持<note>标记。由于NDoc已经过时，您可以在NDoc3中查看此功能，这绝对值得一看，因为它也能够创建纯HTML文档，而不仅仅是假设asp.net的在线文档。