Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | Last revisionBoth sides next revision |
| config:templates [2019/10/17 13:56] – added clarification on comment strings wesdean | config:templates [2019/10/24 20:56] – add clarification re: single vs multiline comments wesdean |
|---|
| ==== Automatic Comment Strings it Templates ==== | ==== Automatic Comment Strings it Templates ==== |
| |
| Most templates (fileheader, function, gpl, bsd) will automatically include the comment strings (e.g., '#' to start a shell script comment) when they are inserted; however, file templates and the changelog template do not include the strings to signal comments. The exact comment strings are determined based on the filetype of the document into which they are being inserted. | Most templates (fileheader, function, gpl, bsd) will automatically include the comment strings (e.g., '#' to start a shell script comment) when they are inserted; however, file templates and the changelog template do not include the strings to signal comments. The exact comment strings are determined based on the filetype of the document into which they are being inserted. By default, multi-line comments are preferred to single-line comments if both single- and multi-line comments are available. |
| |
| ==== File Templates ==== | ==== File Templates ==== |
