// comment
This is a note to myself about how to put comments in the code that I mainly work with.
comment type Language(s) | Comment Syntax | Notes |
---|---|---|
inline[1] |
| removed by Asciidoctor in HTML output |
block[2] |
| removed by Asciidoctor in HTML output |
inline |
| |
block |
| the string |
inline |
| “rem” is case insensitive; it means remark |
block |
| the string |
inline or block |
or…
| removed by Hugo in HTML output; examples in Infinite Ink’s Hugo Tips, Shortcodes, and Fragments |
inline or block |
| |
inline |
| allowed only sometimes, e.g. in Visual Studio Code’s settings.json. See stackoverflow.com’s Can comments be used in JSON? |
inline or block |
| requires PowerShell 2.0[4] or later |
inline or block |
| not removed by SASS in CSS output |
inline or block |
| not removed by SASS in CSS output |
inline |
| removed by SASS in CSS output |
inline |
| |
block |
| this is a hack that is discussed in stackoverflow.com’s How do you do block comments in YAML? Also see yaml-multiline.info. |
$psversiontable
, $psversiontable.psversion
, or $psversiontable.psversion.major
at a PowerShell prompt.