c# - C# xml 文档：如何创建注释？

Question

我想在我自己的文档中的此 MSDN 页面的备注部分中实现与黄色“注意：”框类似的事情。

我正在使用 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 说明
• cs/CSharp/c#/C#/visual c#注释
• cpp/c++/C++/CPP/visual c++ 笔记
• JSharp/j#/J#/visual j#注释
• 实施
• 呼叫者
• 继承

Answer 2

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

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