Summary
Use this attribute to write the help text that describes (documents) a command-line option or command. Specifying
multiple strings will create multiple columns in the table. See Remarks.
Remarks
This attribute specifies the documentation in plain text. All characters are printed exactly as specified. You may
wish to use
DocumentationRhoMLAttribute to specify documentation with special markup for
command-line-related concepts, as well as
DocumentationEggsMLAttribute for an alternative markup
language without command-line specific concepts.
Constructors
|
Use this attribute to write the help text that describes (documents) a command-line option or command. Specifying
multiple strings will create multiple columns in the table. See Remarks. |
Instance properties
| string | | Gets a string describing the documentation format to the programmer (not seen by the users). |
| string[] | | Gets the original documentation string exactly as specified in the attribute. |
| ConsoleColoredString[] | |
Gets the console-colored documentation string. Multiple strings may be returned to create multiple columns. Note
that this property may throw if the text couldn't be parsed where applicable. |