一段優雅的代碼從註釋開始

好的代碼規範是一個程序員的基本修煉，可是每每你們都在各類命名、縮進、可讀性等地方下文章，卻忽略了能最直接，最通俗易懂的註釋規範

經常使用的註釋標籤

@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 ...
複製代碼

附

每一個團隊的編碼規範都不同，選擇合適本身團隊的就行。但優雅的代碼都是從註釋開始的，不要忽略了最重要的一點。