User defined tags. The names <user1>, <user2>, ..., <userN> are their default names and can be changed by the user. These tags are top-level tags in XML comment and they cannot be nested inside other tags. You can create your own topic sections with them. They can be used for any purpose and their syntax and usage is the same as e.g. <remarks> tag. User can define unlimited number of such tags.

User defined fields have the same format as Remarks and by default they are shown at the end of topic under Remarks. If they are used and you want them appear on some other place, you need to edit output templates.

Syntax

<user1>description<user1>

Examples

User has defined one tag as copyright and one tag as todo.

Visual Basic

''' <copyright>(c) 2009 Helixoft</copyright>

''' <todo>Improve exception handling</todo>

Property prop1() As String

C#

/// <copyright>(c) 2009 Helixoft</copyright>

/// <todo>Improve exception handling</todo>

public string prop1

 

See Also

Templates | Macro Language | User Tags Options | XML Comments