首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >将单行注释转换为多行JavaScript

问将单行注释转换为多行JavaScript
EN

Stack Overflow用户
提问于 2017-03-16 15:29:59
回答 1查看 449关注 0票数 2

我想缩小我的JavaScript文件,但是单行注释有问题,缩小的行变成了注释。

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

我不能手动做这件事,因为有许多js文件和批次代码。

有没有什么在线工具或方法可以做到这一点呢?如果有什么解决办法,请告诉我。

EN

回答 1

Stack Overflow用户

发布于 2017-06-30 17:54:32

那么,有很多方法可以缩小包/构建,所以它可能取决于您的缩小过程或评论风格,这是导致这个问题。

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

我使用了grunt minify,即https://www.npmjs.com/package/grunt-node-minify

下面是我使用的评论风格。在JavaScript中添加注释的方法有很多种;以下是我的建议/最佳实践:

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

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

代码语言:javascript
复制
/**
* 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

来源: https://stackoverflow.com/questions/10126310/does-javascript-have-a-standard-for-commenting-functions/39391392#39391392

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

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

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/42827791

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档