JSDoc是什麼？ JSDoc註釋規範的介紹

這篇文章帶給大家的內容是關於JSDoc是什麼？ JSDoc註解規範的介紹，有一定的參考價值，有需要的朋友可以參考一下，希望對你有幫助。

什麼是 JSDoc

JSDoc 是一個根據 JavaScript 檔案中註解訊息，產生 JavaScript 應用程式或模組的API文件的工具。你可以使用 JSDoc 標記如：命名空間，類，方法，方法參數等。從而使開發者能夠輕易地閱讀程式碼，掌握程式碼定義的類別和其屬性和方法，從而降低維護成本，並提高開發效率。

JSDoc 註解規則

JSDoc註解一般應該放置在方法或函數宣告之前，它必須以/ **開始，以便由JSDoc解析器辨識。其他任何以  /*  ，  /***  或超過3個星號的註釋，都將被JSDoc解析器忽略。如下所示：

/*
**一段简单的 JSDoc 注释。
*/

JSDoc 的註釋效果

#假如我們有一段這樣的程式碼，沒有任何註釋，看起來是不是有一定的成本。

functionBook(title, author){
      this.title=title;
      this.author=author;
}
Book.prototype={
      getTitle:function(){
        returnthis.title;   
      },
setPageNum:function(pageNum){
      this.pageNum=pageNum;   
}
};

如果使用了 JSDoc 註解該程式碼後，程式碼的可閱讀性就大大的提高了。

/**
* Book类，代表一个书本.
* @constructor
* @param {string} title - 书本的标题.
* @param {string} author - 书本的作者.
*/
functionBook(title, author){
    this.title=title;
    this.author=author;
}
Book.prototype={
/**
* 获取书本的标题
* @returns {string|*} 返回当前的书本名称
*/
getTitle:function(){
    returnthis.title;   
},
/**
* 设置书本的页数
* @param pageNum {number} 页数
*/
setPageNum:function(pageNum){
    this.pageNum=pageNum;   
}
};

@constructor 建構子宣告註解

@constructor明確一個函數是某個類別的建構子。

@param 參數註解

我們通常會使用@param來表示函數、類別的方法的參數，@param是JSDoc中最常用的註解標籤。參數標籤可表示一個參數的參數名稱、參數類型和參數描述的註解。如下圖所示：

/**
* @param {String} wording 需要说的句子
*/
functionsay(wording){
    console.log(wording);
}

@return 傳回值註解

#@return表示一個函數的回傳值，如果函數沒有顯示指定回傳值可不寫。如下所示：

/*
* @return {Number} 返回值描述
*/

@example 範例註解

#@example通常用於表示範例程式碼,通常範例的程式碼會另起一行編寫，如下所示：

/*
* @example
* multiply(3, 2);
*/

其他常用註解

@overview對目前程式碼檔案的描述。

@copyright程式碼的版權資訊。

@author  []程式碼的作者資訊。

@version目前程式碼的版本。

以上是JSDoc是什麼？ JSDoc註釋規範的介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！