注釋
介紹
作用
合作分享：方便他人閱讀，便於分享
沉淀總結：容易忘記代碼，自己總結沉淀
形式
1.// 雙斜杠
2．/**/斜杠星號
常用標簽
| 標簽 |
描述 |
| @module |
標明當前文件模塊，在這個文件中的所有成員將被默認為屬於此模塊，除非另外標明 |
| @submodule |
針對模塊的划分，處於@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 |
插入一個指向向導教程的鏈接 |
更多標簽可參考
http://yui.github.io/yuidoc/syntax/index.html
開發工具
sublime+DocBlockr
/** Tab(回車)自動生成注釋
在注釋中回車自動生成 *
輸入@會自動提示標准注釋的標簽
文檔輸出
YUIDoc
不解析文本，完全按照注釋標簽進行生成文檔，與代碼分離
NodeJs環境
https://nodejs.org/download/ 下載node.js
安裝YUIDoc
npm install –g yuidocjs
使用
在相應的目錄下輸入 yuidoc . ，會在當前目錄生成 out文件，里面生成注釋文檔
在相應的目錄下輸入 yuidoc . –server <port>，會使用nodejs環境生成對應的網站
編寫Js注釋
l 以 /** 開頭，*/ 結束
l 按照層級格式編寫
@module,[@sumodule], @class,@method,@property等層級格式
l @method，@property，@param等必須在@class下面
l 每個標簽快里面只能包含下面一個標簽，描述了當前代碼塊的作用。
@module 標簽描述一組關聯的類（對，對，JS 沒有類，YUIDoc只是把有構造方法也歸為類罷了）。
@class標簽專門描述類的。在YUI庫中通常是個構造函數。每個有@class 標簽的注釋塊都應該有一個@static 或者 @constructor的副標簽。
@method 描述類中的方法。你將會用到 @return 和 @params 副標簽加以說明。
@property 描述類中的屬性
@event 描述你自定義的可觸發事件。YUIDoc文檔里指出: