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?

2 Answers 2

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
Sign up to request clarification or add additional context in comments.

3 Comments

Cool. That just works! Didn't find the tag in the 'offical' list, but its good to know that also NDoc tags are supported.
Yes. It is not supported officially, but SandCastle was inspired exactly with NDoc: blogs.msdn.com/b/sandcastle/archive/2006/11/22/…
THX, +1 from me. Just a side-note: I think you should generally not include <note>s in the <summary> section. <remarks> should be more appropriate.
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.

1 Comment

Thanks, but our infrastructure already relies on SC and can't be changed that easily.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.