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:
You can use triple-quoted strings. When they’re not a docstring (the first thing in a class/function/module), they are ignored. (Make sure to indent the leading ”’ appropriately to avoid an IndentationError.) Guido van Rossum (creator of Python) tweeted this as a “pro tip”. However, Python’s style guide, PEP8, favors using consecutive single-line comments, like this: …and this is also what you’ll find … Read more