### HBuilder JSDoc+規范
目錄
#### 介紹
JSDoc有2個作用,導出API文檔和明確代碼類型,輔助代碼提示。
JSDoc描述了函數或變量的功能、值域、示例等很多代碼提示時需要的數據,還可以通過類型定義,給動態的JS變量或函數賦予明確的類型。
HBuilder支持JSDoc3的書寫和解析,JSDoc 3詳細的標簽介紹及語法請參考JSDoc 3。
但標準的JSDoc是不夠的,為了提高JS代碼類型解析的精確性和實現更強大的代碼助手提示,我們擴展了JSDoc。
-對于普通開發者,書寫JSDoc有助于代碼可讀性的提升,在很多要求嚴格的大公司,JSDoc是強制要求編寫的。
完善的JSDoc也能讓開發者自定義的函數在引用時得到更方便的代碼提示。
-對于框架開發者,書寫好的JSDoc是必須的,除了生成API手冊,良好的JSDoc可以讓框架在IDE里得到更好的提示。
-開發者們也可以給別人的JS框架補充JSDoc,以便在HBuilder里得到更好的提示。
如果你完成了某個框架的JSDoc,請提交到`https://github.com/dcloudio/WebFrameworkGrammar`,廣大開發者都在期待你給大家帶來的便利。
另外共享框架語法是可以獲得HBuilder積分獎勵的哦。
JSDoc寫法
~~~
/** 文檔注釋寫在這里 ,生成JSDoc的快捷鍵是[Alt+shift+J]。 */。
~~~
* * * * *
http://www.html5plus.org/doc/jsdocp.html
http://ask.dcloud.net.cn/article/129