In what ways can you comment in CoffeeScript?
The documentation say you can use three hash symbols to start and close a comment block:
###
Comments
go
here
###
I've found that I can sometimes use the following two formats
`// backticks allow for straight-JavaScript,
// but the closing backtick can't be on a comment line (I think?)
`
Are there a simpler way to insert short comments in CoffeeScript?
Do NOT use this style**
Since this is getting a lot of views, I want to emphasize that
/* Comment goes here */
produces a MATH error when the /*
is on its own line.
As Trevor pointed out in a comment on the question, this is a regular expression, NOT a comment!
The main way to comment is sh/Perl/Ruby/... style
#
comments:You use the block style
###
comments when you want a comment to appear in the JavaScript version:So if you start with
then you'd get this JavaScript comment in the generated JavaScript:
Use a single # sign
One character seems pretty minimal ;)
Also:
Beware of ###! If you use ### to separate sections of code (as I do) it's awfully surprising when that code stops working as a result.