从.coffee编译后，在.js文件中维护注释

Question

我想在输出的JavaScript文件中保留我在CoffeeScript文件中写的注释。我怎么能这样做？

#!/usr/bin/env bash

./node_modules/.bin/coffee --output lib/ --compile --bare --watch src/

Answer 1

来自coffee-script documentation：

  

反映heredocs语法的块注释将保留在生成的代码中。

这（借用下面的typeonerror的回复 - 整洁！）：

###*
# This will be preserved in a block comment in the javascript
###

编译到：

/**
 * This will be preserved in a block comment in the javascript
 */

Answer 2

扩展Linus的上述答案，我发现这是获得我想要的评论风格的最佳风格：

###*
# Hello world
# @param Object object
# @return String
###

添加第一个###门会启动评论，而其他*会给我们

/**
 * Hello world
 * @param Object object
 * @return String
 */