<para> (Visual Basic)

Specifies that the content is formatted as a paragraph.

<para>content</para>

Parameters

  • content
    The text of the paragraph.

Remarks

The <para> tag is for use inside a tag, such as <summary> (Visual Basic), <remarks> (Visual Basic), or <returns> (Visual Basic), and lets you add structure to the text.

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

Example

This example uses the <para> tag to split the remarks section for the UpdateRecord method into two paragraphs.

''' <param name="id">The ID of the record to update.</param> 
''' <remarks>Updates the record <paramref name="id"/>. 
''' <para>Use <see cref="DoesRecordExist"/> to verify that 
''' the record exists before calling this method.</para> 
''' </remarks> 
Public Sub UpdateRecord(ByVal id As Integer)
    ' Code goes here. 
End Sub 
''' <param name="id">The ID of the record to check.</param> 
''' <returns><c>True</c> if <paramref name="id"/> exists, 
''' <c>False</c> otherwise.</returns> 
''' <remarks><seealso cref="UpdateRecord"/></remarks> 
Public Function DoesRecordExist(ByVal id As Integer) As Boolean 
    ' Code goes here. 
End Function

See Also

Reference

Recommended XML Tags for Documentation Comments (Visual Basic)