Format using: <!-- -->
Example:
Single-line
<!-- my single line comments -->Multi-line
<!--
my multi line comments
comments continue on this line
-->Automatically determine if multi line comments or single line comments should be applied.
If input is a single line // will be applied.
If input is multi-line then /* */ will be applied.
Format using: /** */
Example:
/**
* my multi line comments
* comments continue on this line
*/
Format using: /** */
Example:
/**
* my multi line comments
* comments continue on this line
*/
No formatting
Format using prefix of: #
Example:
# my multi line comments
# comments continue on this lineFormat using prefix of: //
Example:
// my multi line comments
// comments continue on this lineFormat using prefix of: *
Useful for comment replacement that is required inline.
Example:
If you have the following.
/**
* [[include:doc/myMarkdown.md]]
*/
The output would be similar to the following.
/**
* my multi line comments
* comments continue on this line
*/
Parses a value to enum of commentKind
The string or number to convert into enum
If true will match an enum value of any case; Otherwise, case must match.
The minimum value that is accepted as a valid enum value.
The maximum value that is accepted as a valid enum value.
The value converted into commentKind
Generated using TypeDoc
Indicates the kind of comments to format a replacement file with.
Extend enum commentKind to have a parse method