摘要：之前自己写代码，就像一盘散沙，完全没有一种规范。经过最近一段时间的开发，和对一些注释风格的参考，形成了自己想去使用的注释规范。如果变量注释有点长，就不太好了。
之前自己写代码，就像一盘散沙，完全没有一种规范。这种自由，会让自己写的东西时常变化。也很不利于团队协作开发。经过最近一段时间的开发，和对一些注释风格的参考，形成了自己想去使用的注释规范。
js的组织是模块化，一个模块对应一个js文件。
模块功能描述说明：
/** * ------------------------------------------------------------------ * 模块描述说明 * ------------------------------------------------------------------ */
我喜欢开始和结束各空一行，中间是描述内容。
模块内的小函数方法归类：
/** * 小函数方法归类说明，这些零散的小函数方法放在一起 对应 一个业务方法逻辑 * ------------------------------------------------------------------ */
把一个业务方法中抽取出来的小函数放在一起，便于查找。
单个函数方法：
/**
* 函数功能简述
*
* 具体描述一些细节
*
* @param {string} address 地址
* @param {array} com 商品数组
* @param {string} pay_status 支付方式
* @returns void
*
* @date 2014-04-12
* @author QETHAN
*/
开发中使用的是PhpStorm IDE, 每次创建一个js新文件，文件内容头部会根据配置文件模板去自动加上一些注释信息。我配置的是 日期 和 作者。现在是一个人开发，所以上边注释中的日期和作者 我一般不会在函数中去加上。但是，如果其他人参与进来了，自己修改的是别人的代码，就要更新添加这些注释信息。
单行注释：
//这是一条单行注释
有些人喜欢这样 // 这是一条单行注释 双斜杠后边会加一个空格。我不认同。喜欢干练清晰简洁，在适合的时候，就一定会这样做。
单个函数方法中变量注释：
//商品属性变量(一组变量描述)
//商品名字(单个变量注释)
var name = $(item).find(".js-name").val(),
//商品数量
count = $(item).find(".js-count").text(),
//商品单价
price = $(item).find(".js-price").val();
有些喜欢注释放在单个变量后边。如果变量注释有点长，就不太好了。放在上边，比较省心，清晰。
单个函数方法中代码片段注释：
/* | 代码片段的描述说明 */
if, foreach, addEventListener ... 这些代码片段的时候
注释中缩进 必须使用空格。保证各种环境下排版的一致性。
@use JSDoc
<持续维护更新...>
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/78081.html
一、前言昨天一个朋友问：我的工作只有vue、react，了解其他的好像没有太大作用。其实不然，前端要考虑的内容其实很多，不光是完成业务代码。我司的一个控制台前端维护人数在20+，如果每个人都在一个项目中开发，那么每天就等着构建了，不仅容易出错，而且浪费时间，这对于线上项目是不可容忍的。前端项目有大有小，这里假设我们面对的是一个相对复杂的中台系统，那么要考虑的东西是很多的。下面我列举了大部分，如果有...
摘要：小驼峰式命名法首字母小写。文件资源命名文件名不得含有空格文件名建议只使用小写字母，不使用大写字母。可执行不可执行判断是否含有某个值函数返回一个布尔值。使用文档声明类型的作用是为了防止开启浏览器的怪异模式。 本文首发于我的个人网站：http://cherryblog.site/ （背景更换了不知道大家有没有发现呢，嘻嘻） 一个好的程序员肯定是要能书写可维护的代码，而不是一次性的代码，怎么...
摘要：前言作为一名全干打字员，干活时经常会被要求使用各种各样的语言去实现各种各样的需求，来回切换起来写的代码就会或多或少有点不规范。今天我们以为例，讲讲在代码中，我们需要注意的某些规范。 前言 作为一名全干打字员，干活时经常会被要求使用各种各样的语言去实现各种各样的需求，来回切换起来写的代码就会或多或少有点不规范。今天我们以JAVA为例，讲讲在代码中，我们需要注意的某些规范。（本文标准依赖于...
阅读 1659·2021-11-16 11:41
阅读 2456·2021-11-08 13:14
阅读 3106·2019-08-29 17:16
阅读 3079·2019-08-29 16:30
阅读 1843·2019-08-29 13:51
阅读 356·2019-08-23 18:38
阅读 3223·2019-08-23 17:14
阅读 630·2019-08-23 15:09
