I believe that all the previously proposed solutions (apart from those that require specific implementations) result in the comments being included in the output HTML, even if they are not displayed. If you want a comment that is strictly for yourself (readers of the converted document should not be able to see it, even with … Read more
In PowerShell V1 there’s only # to make the text after it a comment. In PowerShell V2 <# #> can be used for block comments and more specifically for help comments. For more explanation about .SYNOPSIS and .* see about_Comment_Based_Help. Remark: These function comments are used by the Get-Help CmdLet and can be put before the keyword Function, or inside the {} before or after the code itself.
No. The JSON is data only, and if you include a comment, then it will be data too. You could have a designated data element called “_comment” (or something) that should be ignored by apps that use the JSON data. You would probably be better having the comment in the processes that generates/receives the JSON, … Read more
YAML supports inline comments, but does not support block comments. From Wikipedia: Comments begin with the number sign ( # ), can start anywhere on a line, and continue until the end of the line A comparison with JSON, also from Wikipedia: The syntax differences are subtle and seldom arise in practice: JSON allows extended … Read more
You can use that style of comment across multiple lines (which exists also in HTML)
Javadocs are a specific comment format used to generate external documentation for your code. You shouldn’t be converting regular comments to Javadoc. For example: See this technical doc for more details. If you do want to convert the comments, though, you would have to do it manually like you said. There isn’t a specific tool … Read more
You can use that style of comment across multiple lines (which exists also in HTML)
No. The JSON is data only, and if you include a comment, then it will be data too. You could have a designated data element called “_comment” (or something) that should be ignored by apps that use the JSON data. You would probably be better having the comment in the processes that generates/receives the JSON, as they … Read more
The JSON is data only, and if you include a comment, then it will be data too. You could have a designated data element called “_comment” (or something) that should be ignored by apps that use the JSON data. You would probably be better having the comment in the processes that generates/receives the JSON, as they are … Read more
I don’t know how future and/or exotic browsers will interpret non-official hacks like //, so I’d rather stick with the appropriate notation: