-> preserves return value whitespace/comment; support CoffeeScript comment blocks ###...### anywhere /*...*/ works

[edemaine]

There was a TODO to support ###...### inline like /*...*/, and I did that. The TODO suggested restricting support to coffeeComment mode, but our current support for ###...### doesn't do that, so I didn't here, but left another note. Happy to restrict to coffeeComment if desired (though this would be a breaking change). Hmm, docs should reflect whatever we decide.

Jumped through a few hoops to preserve the whitespace and, when relevant, not add the automatic space before {. Code is a little ugly but it works.

Fixes #1826

[Kristinita]

Type: Proposal ➕

@edemaine, 3 weeks ago I created the pull request to the repository of the one ESLint plugin. In this pull request I prevented deletion of flotate comments by this plugin.

I created 10 tests in my pull request. A function may have 0, 1, or more parameters, single-line and multiline comments, and comments inside a function body. I have considered all these cases in my tests.

I think users will have fewer chances to get unexpected bugs if Civet will have similar tests for more cases of possible comments and parameters.

Thank you for the pull request.

[edemaine]

@Kristinita Thanks for the suggested tests! Because of the way the parser works, I don't think we need to add cases where comments are absent, but I added tests for the function style of functions and multiple arguments.