将单行注释转换为多行JavaScript

时间:2017-03-16 07:29:59

标签: javascript comments minify

我想缩小我的JavaScript文件,但单行评论有问题,缩小的行会被评论。

因此,我尝试将所有单行注释转换/转换为多行注释。

我无法手动执行此操作,因为有许多js文件和批次代码。

是否有任何在线工具或方法可以实现此目的? 如果有任何解决方案,请告诉我。

1 个答案:

答案 0 :(得分:1)

嗯,有很多方法可以缩小包/构建,因此可能取决于您的缩小过程或导致此问题的评论样式。

但是,我想分享我使用的方法,没有任何问题/错误。

  

我使用了grunt node minify

即。 https://www.npmjs.com/package/grunt-node-minify

  

以下是我使用的评论方式 -

有很多方法可以在javascript中添加评论;这是我的推荐/最佳做法

使用//优于/* */,因为您可以使用后者取出包含其他注释的整个块。但是,如果要使用自动文档生成工具,则必须使用类似于javaDoc样式的注释。

这是一个适用于YUI DOC(最佳)http://developer.yahoo.com/yui/yuidoc/#start

的示例
/**
* This is a description
* @namespace My.Namespace
* @method myMethodName
* @param {String} str - some string
* @param {Object} obj - some object
* @param {requestCallback} callback - The callback that handles the response.
* @return {bool} some bool
*/
    function SampleFunction (str, obj, callback) {
         var isTrue = callback(str, obj); // do some process and returns true/false.
         return isTrue ;
    }

其他参数示例: - http://usejsdoc.org/tags-param.html

来源: - Does JavaScript have a standard for commenting functions?

  

注意 - 我使用uglify尝试使用单行/多行注释,没有任何错误。

即。 https://github.com/gruntjs/grunt-contrib-uglify

希望这会对您有所帮助:)