C# xml documentation: How to create Notes?

Question

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?

Answer 1

/// <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