CODEWITHSUNDEEP
c#tagsxml-documentation
Sebastian P.R. Gingter
Sebastian P.R. Gingter

Reputation: 6085

C# xml documentation: How to create Notes?

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?

Upvotes: 13

Views: 3645

Answers (2)

chopikadze
chopikadze

Reputation: 4239

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

Upvotes: 17

Emiswelt
Emiswelt

Reputation: 4009

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.

Upvotes: 0

Related Questions