Comments
Comments are pieces of text wrapped with <##
and ##>
that DocuMold will remove when generating a
document. They are there to provide information / explanation to someone that would edit the template.
Just like commands, comments can be placed anywhere in the template: in the middle of a paragraph, of a table, etc. The only limitation is that a comment cannot be in a command and vice versa.
Basic example
Here is a simple example of a comment:
Hello,
<## This is a comment ##>
Do something
You can make it as long as you want and can change paragraphs within the comment, etc.
When you generate a document with the template, the result would be
Hello,
Do something
Limitations
As mentioned in the beginning, you cannot put a command in a comment, nor put a comment in a command.
If you want a comment to contain #>
or ##>
without getting an error or ending the comment at that point, place
quotes directly around it (without spaces). Like this:
Hello,
<## A command starts with "<#" and ends with "#>" ##>
Do something
Gives:
Hello,
Do something