comment formatting

[hoodie]

There have already been a few issues about comments in coffeescript. I was wondering what you might think about allowing documentary comments in coffeescript.

/**
 * blocks like these are being used by tools like yuidoc
 *
 */

###
# however in coffeescript you would expect something like this
#
###

###
 * not something like this
 *
###

Means it would be cool if leading '#'s inside a block comment would be turned ' *'.
What do you thing about that?

[jashkenas]

I'm not a fan of fancy/strange comment ornamentation. Personally, I'd prefer a language where the only kind of comment is a single character that leads a line.

# Like
# this
# does.

... CoffeeScript also has block comments -- mostly for consistency with block strings and block regexes, but also to allow you to pass comments through to the compiled JS. Changing the way comments work for a particular documentation tool isn't going to happen.

[satyr]

Related: #1050

[hoodie]

what I actually meant whats that, in order to get the first block I wrote you need to write the third one
but it would be nice if coffee-script would turn a leading "#" within a block comment into a "".
This is also because vim for example automatically writes a # at a new line within a block comment, so you always have the second kind of block in there. but after that has been turned into javascript it will look like this
/*
# inconsistent comment style
*/

that is just not pretty