JavaScript 註解的三種寫法

基本註解

單行註解：

    
// 註解
    

多行註解：

    
    /*
    多行註解
    */
    

JSDoc

在方法區塊上面使用 /** ，應該會自動產生註解，在好的開發工具或是裝了正確的套件之後，應該會產生如下的註解：

    
/**
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function add(a, b) {
    return a + b;
}
    

加上完整註解後如下：

    
/**
 * 將兩個數字相加
 * @param {number} a 第一個數字
 * @param {number} b 第二個數字
 * @returns {number} 相加的結果
 */
function add(a, b) {
    return a + b;
}
    

在使用方法時可以看到如下的提示：

VS Code:

WebStorm:

在 @param 中可以使用下列的型別: Object, string, number, boolean, *, 可空: {?number}, 不可空: {!number}

參考資料：
JSDoc