一段优雅的代码从注释开始

好的代码规范是一个程序员的基本修炼，但是往往大家都在各种命名、缩进、可读性等地方下文章，却忽略了能最直接，最通俗易懂的注释规范

常用的注释标签

@desc 描述
@author 作者
@return 返回值
@returns 多个返回值
@param 参数
@callback 回调函数
@throws 可能抛出的错误
@file 描述一个文件
@function 描述一个函数或方法
@global 记录一个全局对象
@version 记录版本号
...

举个栗子

/**
 * @author 7coder
 * @desc 数组去重
 * @param { Array } arr 待被去重数组 // 花括号中标记数据类型
 * @return 去重后的数组
 */
function (arr) {
    var array = [];
    for (var i = 0; i < arr.length; i++) {
        if (array .indexOf(arr[i]) === -1) {
            array .push(arr[i])
        }
    }
    return array;
}

第二个栗子

/**
 * @author 7coder
 * @desc 使用'-'拼接字符串
 * @param { String|Number } s1 字符串1 // 类型可以是string也可以是number
 * @param { String|Number } [ s2 ] 字符串2 // []表示为可选参数
 * @return 拼接后的字符串
 */
 function joint (s1, s2) {
    return `${s1}-${s2}`
 }

更多JSDoc注释类容可以参考 JSDoc文档

单行注释

行注释主要是简介的表达清楚就行，另外有这几种常见的

// TODO ...
// FIXME ...
// NOTE ...

附

每个团队的编码规范都不一样，选择合适自己团队的就行。但优雅的代码都是从注释开始的，不要忽略了最重要的一点。