常用標簽
@module
標明當前文件模塊,在這個文件中的所有成員將被默認為屬于此模塊,除非另外標明
@submodule
針對模塊的劃分,處于@module之下
@class
標示一個類或者一個函數(shù)
@constructor
當使用對象字面量形式定義類時,可使用此標簽標明其構(gòu)造函數(shù)
@callback
標明此方法是一個回調(diào)函數(shù)
@event
標明一個可觸發(fā)的事件函數(shù),一個典型的事件是由對象定義的一組屬性來表示。
@constant
常量標識
@member/@var
記錄一個基本數(shù)據(jù)類型的成員變量
@method
標記一個方法或函數(shù)
@param
標記方法參數(shù)及參數(shù)類型
@property
標明一個對象的屬性
@readonly
只讀
@return
標明返回值、類型及描述
@type
描述代碼變量的類型
@description
如果在注釋開始描述可省略此標簽
@enum
一個類中屬性的類型相同時,使用此標簽標明
@example
示例,代碼可自動高亮
@exports
標識此對象將會被導出到外部調(diào)用
@ignore
忽略此注釋塊
@link
內(nèi)聯(lián)標簽,創(chuàng)建一個鏈接,如 {@link http://github.com Github}
@name
指定一段代碼的名稱,強制 JSDoc 使用此名稱,而不是代碼里的名稱
@namespace
指定一個變量為命名空間變量
@static
描述一個不需實例即可使用的變量
@summary
對描述信息的短的概述
@throws
描述方法將會出現(xiàn)的錯誤和異常
@todo
描述函數(shù)的功能或任務(wù)
@tutorial
插入一個指向向?qū)Ы坛痰逆溄?/p>