C# xml 文档：如何创建注释？答案

【问题标题】：C# xml documentation: How to create Notes?C# xml 文档：如何创建注释？
【发布时间】：2011-10-09 02:59:07
【问题描述】：

我想在我自己的文档中实现与this MSDN page 备注部分中的黄色“注意：”框类似的东西。

我正在使用sandcastle 和sandcastle 帮助文件生成器从文档标签中生成参考网站。我要写什么才能实现这样的笔记框？

【问题讨论】：

【解决方案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#注释
cpp/c++/C++/CPP/visual c++ 笔记
JSharp/j#/J#/visual j# 注释
实现
来电者
继承

【讨论】：

酷。那行得通！在“官方”列表中未找到该标签，但很高兴知道也支持 NDoc 标签。
是的。它不受官方支持，但 SandCastle 的灵感完全来自 NDoc：blogs.msdn.com/b/sandcastle/archive/2006/11/22/…
THX，来自我的 +1。只是一个旁注：我认为您通常不应该在
部分中包含 s。应该更合适。

【解决方案2】：

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

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

【讨论】：

谢谢，但我们的基础架构已经依赖于 SC，无法轻易更改。