Edit

Share via

<c> (Visual Basic)

  • Article

Indicates that text within a description is code.

Syntax

<c>text</c>

Parameters

Parameter Description
text The text you would like to indicate as code.

Remarks

The <c> tag gives you a way to indicate that text within a description should be marked as code. Use <code> to indicate multiple lines as code.

Compile with -doc to process documentation comments to a file.

Example

This example uses the <c> tag in the summary section to indicate that Counter is code.

''' <summary>
''' Resets the value of the <c>Counter</c> field.
''' </summary>
Public Sub ResetCounter()
    counterValue = 0
End Sub
Private counterValue As Integer = 0
''' <summary>
''' Returns the number of times Counter was called.
''' </summary>
''' <value>Number of times Counter was called.</value>
Public ReadOnly Property Counter() As Integer
    Get
        counterValue += 1
        Return counterValue
    End Get
End Property

See also