XML Comments - Note section in MSDN documentation - how do you duplicate this?

Basically, in the MSDN online help, I often come across the “NOTE” section, but I can’t understand for life how to get the same result. There seems to be no tag <note>. Does anyone know how to make this work?

IDictionary (TKey, TValue) - In this example, if you go to the comments section, you will see what I'm talking about.

I am using Sandcastle tooltip builder.

+5
source share
3 answers

, Sandcastle, Sandcastle Help File Builder <note>, !:-) , :

<note>. ( , Dyncity , .)

Syntax of note element

, , , <note>. , . :


Sample Sandcastle note output

, type="caution" , . , , .

+6

Sandcastle , Sandcastle, XML- #.

, , , Sandcastle ( , , ):

<alert class="note">This is a 'alert class=note'</alert>

. Microsoft Longhorn.

+1

cubrr , Note Sandcastle.

, xml , , . , , . , -, , , . .

The following code generated the following result for me:

/// <remarks>
/// <note type="note">
/// This is a note in a remark. It is a General note.
/// </note>
/// <note type="tip">
/// This is a tip note in a remark. It is a General note.
/// </note>
/// <note type="implement">
/// This is a implement note in a remark. It is a General note.
/// </note>
/// <note type="caller">
/// This is a caller note in a remark. It is a General note.
/// </note>
/// <note type="inherit">
/// This is a inherit note in a remark. It is a General note.
/// </note>
/// <note type="caution">
/// This is a caution note in a remark. It is a Cautionary note.
/// </note>
/// <note type="important">
/// This is a important note in a remark. It is a Cautionary note.
/// </note>
/// <note type="security">
/// This is a security note in a remark. It is a Security note.
/// </note>
/// <note type="cs">
/// This is a cs note in a remark. It is a Language note.
/// </note>
/// </remarks>

Result: Generated help file

+1
source

All Articles