从 .coffee 编译后维护 .js 文件中的注释答案

【问题标题】：Maintaining comments in .js files after compilation from .coffee从 .coffee 编译后维护 .js 文件中的注释
【发布时间】：2016-12-16 02:11:14
【问题描述】：

我想在输出的 JavaScript 文件中保留我在 CoffeeScript 文件中编写的 cmets。我该怎么做？

#!/usr/bin/env bash

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

【问题讨论】：

【解决方案1】：

来自coffee-script documentation：

块 cmets，它反映了 heredocs 的语法，保留在生成的代码中。

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

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

编译成这样：

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

【讨论】：

如果评论是 #= require stuff.coffee 怎么办？我需要为我的资产管道执行此操作...如果咖啡不支持此操作，我的 50 行长管道将突然变成 100/150 行长...我不想这样做。
为了转换你所有的资产管道咖啡文件，我写了这个：gist.github.com/koriroys/efc6123a6a471082f313它并不完美，但也许它可以帮助你。
你使用 gulp-rigger？我有同样的问题，因为我想通过装配工在咖啡中导入 js 块。一开始用js编译coffee，像普通的js cmets一样编译cmets。 ###= ../some.js ### - 构造与装配工正常工作 -> /* = ../some.js */
链接已损坏
感谢@SouparnoMajumder，它已被修复。

【解决方案2】：

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

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

添加第一个### 门开始评论，而额外的* 给我们

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

【讨论】：