You often want to insert source code samples in the resulting document. You can use <code> or <c> tags if you are using XML comments.

If you are using @-style comments, VSdocman comes with predefined $CODE$ and $END-CODE$ macros, that are defined in all templates and provide formatting of source code.

 

Example

    '**
    '@example       This is an example how to use prop1 and prop2 properties:

    '$CODE$

    '            Try

    '                If Me.prop1 <> "hello" Then

    '                    prop2 = DllModule1.sampleEnum.value2

    '                End If

    '            Catch ex As nestedException

    '                prop2 = DllModule1.sampleEnum.value1

    '            End Try

    '

    '$END-CODE$

    Property prop1() As String

You do NOT need to add $EOL$ macro at the end of each line so that there were line breaks in all output formats. VSdocman adds them for you in the background during compilation. This happens only inside $CODE$ macro. You must use $EOL$ on other places if you need line break in documentation. Without it it wouldn't work in RTF because RTF syntax has no tag like HTML's <pre> and therefore needs to explicitly define new line.

Note, $CODE$ and $END-CODE$ macros can be also applied to the title page text in the Options dialog.

See Also

Using Macros Directly in Comments