加載中...

JSDoc 介紹


什么是JSDoc

JSDoc是一個根據javascript文件中注釋信息,生成JavaScript應用程序或庫、模塊的API文檔 的工具。你可以使用他記錄如:命名空間,類,方法,方法參數等。類似JavaDoc和PHPDoc。現在很多編輯器或IDE中還可以通過JSDoc直接或使用插件生成智能提示。從而使開發者很容易了解整個類和其中的屬性和方法,并且快速知道如何使用,從而提高開發效率,降低維護成本。

使用JSDoc

JSDoc本質是代碼注釋,所以使用起來非常方便,但是他有一定的格式和規則,只要了解這些,那么后面的事情,比如生產文檔,生成智能提示都可以通過工具來完成。

JSDoc注釋

JSDoc注釋一般應該放置在方法或函數聲明之前,它必須以/ **開始,以便由JSDoc解析器識別。其他任何以/*/***或者超過3個星號的注釋,都將被JSDoc解析器忽略。例如一下代碼:

/**
 * Book類,代表一個書本.
 * @constructor
 * @param {string} title - 書本的標題.
 * @param {string} author - 書本的作者.
 */
function Book(title, author) {
    this.title=title;
    this.author=author;
}
Book.prototype={
    /**
     * 獲取書本的標題
     * @returns {string|*}
     */
    getTitle:function(){
        return this.title;
    },
    /**
     * 設置書本的頁數
     * @param pageNum {number} 頁數
     */
    setPageNum:function(pageNum){
        this.pageNum=pageNum;
    }
}; 

JSDoc注釋標簽

看了上面的代碼注釋是不是一目了然呢,獲取你會疑惑上面以@開頭的標簽是什么意思。 在JSDoc 注釋有一套標準的注釋標簽,一般以@開頭。這里解釋一下每個標簽的意思。

關于別名

因為JSDoc也經歷好幾個版本,所以考慮向后兼容,所以存在別名,另一個方面,別名對于一部分人來說更加直觀。 比如@param有兩個別名:

  • @arg
  • @argument

關于別名詳細說明可以查看上面描述。


還沒有評論.
股票配资平台l选一直牛