jashkenas/coffee-script — Issue #1925: Liberal Block Comments
Author: quangv
Created: 2011-12-10 19:49:18+00:00
State: open

I'm not sure if I'm doing something wrong, please correct me if I am, but I think the block comments of Coffee-Script is too strict...

I don't think block comments should adhere to indent rules, and should be more liberal.

```
foo = 'bar'
###

Only this works.

###
###
This should work I think.
###

### Maybe even this
###
```

As in no indents parse errors on block comments. I think block comments should be of the highest level.

Idk, I think comments should be _deal simple_ to use... I think it should be very liberal, cause you never know when you want to "comment out" stuff... to test etc.

Actually, I wouldn't mind if CoffeeScript comments was the exact same as JavaScript comments... `/* */ `, `//`

... to be honest, maybe we should support all _four_ syntax, the `//` & `#` can be used when you want buffering. You can do things like:

```
/* that didn't work, let's block out more things...

###
First let's block this out...
###

# Don't print me out
// Print me out

*/
```

...

I just realize that you can use here-docs to comment out code, just like _[Python document strings](http://en.wikibooks.org/wiki/Python_Programming/Source_Documentation_and_Comments)_

```
"""
All this...
###
would be blocked out
###
"""

Are there any negatives to writing comments with here-docs ?
```