引見
作用
- 協作分享：輕易別人瀏覽，便於分享
- 沉澱總結：輕易遺忘代碼，總結沉澱
情勢
- // 雙斜杠
- /**/ 斜杠星號
經常運用標籤
| 標籤 | 形貌 |
|---|---|
| @module 1 | 標明當前文件模塊，在這個文件中的一切成員將被默以為屬於此模塊，除非別的標明 |
| @submodule 1 | 針對模塊的分別，處於@module之下 |
| @class | 標示一個類或一個函數 |
| @constructor | 當運用對象字面量情勢定義類時，可運用此標籤標明組織函數 |
| @callback | 標明此要領是一個回調函數 |
| @event | 標明一個可觸發的事宜函數，一個典範的事宜是由對象定義的一組屬性來標示。 |
| @constant | 常量標識 |
| @member/@var | 紀錄一個基礎數據範例的成員變量 |
| @method | 標記一個要領或函數 |
| @param | 標記要領參數及參數範例 |
| @property | 標明一個對象屬性 |
| @readonly | 只讀 |
| @return | 標明返回值、範例及形貌 |
| @type | 形貌代碼變量的範例 |
| @description | 如果在解釋最先形貌可省略此標籤 |
| @enum | 一個類中屬性的範例雷同，運用此標籤標明 |
| @example | 示例，代碼可自動高了 |
| @exports | 標識此對象將會被導出到外部挪用 |
| @ignore | 疏忽此解釋 |
| @link | 內聯標籤，建立一個標籤。如'{@link http://github.com Github}’ |
| @name | 指定一段代碼的名字，強迫JsDoc運用此稱號，而不是代碼里的稱號 |
| @namespace | 指定一個變量定名空間變量 |
| @static | 形貌一個不需實例即可運用的變量 |
| @summary | 對形貌信息的短的概述 |
| @throws | 形貌要領將會湧現的毛病和非常 |
| @todo | 形貌函數的功用和使命 |
| @tutorial | 插進去一個指嚮導游教程的鏈接 |
| @see | 標籤許可您援用可能與被紀錄的相干的另一個標記或資本 |
開發工具
sublime+DocBlockr
/** Tab(回車)自動天生解釋
在解釋中回車自動天生 *
輸入@會自動提醒規範解釋的標籤
文檔輸出
YUIDoc
不剖析文本，完整根據解釋標籤舉行天生文檔，與代碼星散
NodeJs環境
裝置YUIDoc
npm install –g yuidocjs運用
- 在響應的目次下輸入 yuidoc . ，會在當前目次天生 out文件，內里天生解釋文檔
- 在響應的目次下輸入 yuidoc . –server <port>，會運用nodejs環境天生對應的網站
更多標籤可參考：
編寫Js解釋
- 以 /* 開首，/ 完畢
- 根據層級花樣編寫：@module,[@sumodule],@class,@method,@property等層級花樣
- @method，@property，@param等必須在@class下面
- 每一個標籤快內里只能包括下面一個標籤，形貌了當前代碼塊的作用。
- @module 標籤形貌一組關聯的類（關於JS 沒有類，YUIDoc只是把有組織要領也歸為類罷了）。
- @class標籤特地形貌類的。在YUI庫中通常是個組織函數。每一個有@class 標籤的解釋塊都應該有一個@static 或許 @constructor的副標籤。
- @method 形貌類中的要領。你將會用到 @return 和 @params 副標籤加以申明。
- @property 形貌類中的屬性
- @event 形貌你自定義的可觸發事宜。YUIDoc文檔里指出
