Sandcastle XML Comments Guide
SampleClassVariousListExamples Method |
This method shows various examples of the list XML comments element.
Namespace: XMLCommentsExamples
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Syntax
Remarks
A simple bulleted list. The term and description elements are optional for simple string descriptions.
- First item
- Second item
- Third item
Bullet list with terms and definitions. The term is highlighted and separated from the definition with a dash.
- maxLen - field must contain no more than the specified number of characters
- minLen - field must contain at least the specified number of characters
- maxVal - field must contain a number that is no larger than the specified value
- minVal - field must contain a number that is no smaller than the specified value
- pattern - field must match the specified regular expression
A simple numbered list. The term and description elements are optional for simple string descriptions.
- First item
- Second item
- Third item
This next numbered list uses the optional start attribute to continue numbering where the last one left off.
- Fourth item
- Fifth item
- Sixth item
Numbered list with terms and definitions.
- maxLen - field must contain no more than the specified number of characters
- minLen - field must contain at least the specified number of characters
- maxVal - field must contain a number that is no larger than the specified value
- minVal - field must contain a number that is no smaller than the specified value
- pattern - field must match the specified regular expression
Definition list.
- maxLen
- field must contain no more than the specified number of characters
- minLen
- field must contain at least the specified number of characters
- maxVal
- field must contain a number that is no larger than the specified value
- minVal
- field must contain a number that is no smaller than the specified value
- pattern
- field must match the specified regular expression
Two-column table list with terms and definitions.
Item | Description |
---|---|
maxLen | field must contain no more than the specified number of characters |
minLen | field must contain at least the specified number of characters |
maxVal | field must contain a number that is no larger than the specified value |
minVal | field must contain a number that is no smaller than the specified value |
pattern | field must match the specified regular expression |
A table with multiple columns. term or description can be used to create the columns in each row.
Column 1 | Column 2 | Column 3 | Column 4 |
---|---|---|---|
R1, C1 | R1, C2 | R1, C3 | R1, C4 |
R2, C1 | R2, C2 | R2, C3 | R2, C4 |
See Also