13

I want to achieve a similar thing to the yellow 'Note:' box in the remarks section on this MSDN page in my own documentation.

I'm using sandcastle and the sandcastle help file builder to generate a reference website out of the documentation tags. What do I have to write to achieve such a notes box?

Jonathan Leffler
  • 730,956
  • 141
  • 904
  • 1,278
Sebastian P.R. Gingter
  • 5,955
  • 3
  • 31
  • 73

2 Answers2

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

Look at file "C:\Program Files\Sandcastle\Examples\Sandcastle\test.cs"

Type could be one of:

  • note
  • tip
  • caution
  • security
  • important
  • 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
  • implement
  • caller
  • inherit
Paul Groke
  • 6,259
  • 2
  • 31
  • 32
chopikadze
  • 4,219
  • 26
  • 30
  • Cool. That just works! Didn't find the tag in the 'offical' list, but its good to know that also NDoc tags are supported. – Sebastian P.R. Gingter Jul 20 '11 at 07:09
  • Yes. It is not supported officially, but SandCastle was inspired exactly with NDoc: http://blogs.msdn.com/b/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx – chopikadze Jul 20 '11 at 07:12
  • THX, +1 from me. Just a side-note: I think you should generally not include s in the section. should be more appropriate. – Paul Groke Apr 01 '14 at 17:37
0

Not a direct solution, but an alternative:

NDoc supports a <note> Tag. Since NDoc is outdated, you could have a look for this feature in NDoc3, which is definitely worth looking at since it is also also capable of creating plain HTML documentation, not only online documentation which assumes asp.net.

Emiswelt
  • 3,909
  • 1
  • 38
  • 56