问题 C#xml文档:如何创建Notes?


我想在备注部分的黄色'注意'框中实现类似的功能 这个MSDN页面 在我自己的文档中。

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


3301
2017-07-20 06:22


起源



答案:


/// <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
  • 实行
  • 呼叫者
  • 继承

14
2017-07-20 06:57



凉。这才有效!没有在'官方'列表中找到标签,但很高兴知道也支持NDoc标签。 - Sebastian P.R. Gingter
是。它不是官方支持,但SandCastle的确受到NDoc的启发: blogs.msdn.com/b/sandcastle/archive/2006/11/22/... - chopikadze
THX,+1来自我。只是旁注:我认为您通常不应在<summary>部分中包含<note>。 <备注>应该更合适。 - Paul Groke


答案:


/// <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
  • 实行
  • 呼叫者
  • 继承

14
2017-07-20 06:57



凉。这才有效!没有在'官方'列表中找到标签,但很高兴知道也支持NDoc标签。 - Sebastian P.R. Gingter
是。它不是官方支持,但SandCastle的确受到NDoc的启发: blogs.msdn.com/b/sandcastle/archive/2006/11/22/... - chopikadze
THX,+1来自我。只是旁注:我认为您通常不应在<summary>部分中包含<note>。 <备注>应该更合适。 - Paul Groke


不是直接解决方案,而是替代方案:

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


0
2017-07-20 06:47



谢谢,但我们的基础设施已经依赖于SC,无法轻易改变。 - Sebastian P.R. Gingter