資訊專欄INFORMATION COLUMN
摘要：標簽描述一組關(guān)聯(lián)的類對于沒有類，只是把有構(gòu)造方法也歸為類罷了。在庫中通常是個構(gòu)造函數(shù)。每個有標簽的注釋塊都應(yīng)該有一個或者的副標簽。你將會用到和副標簽加以說明。描述類中的屬性描述你自定義的可觸發(fā)事件。
介紹 作用
合作分享：方便他人閱讀，便于分享
沉淀總結(jié)：容易忘記代碼，總結(jié)沉淀
形式// 雙斜杠
/**/ 斜杠星號
常用標簽| 標簽 | 描述 |
|---|---|
| @module 1 | 標明當(dāng)前文件模塊，在這個文件中的所有成員將被默認為屬于此模塊，除非另外標明 |
| @submodule 1 | 針對模塊的劃分，處于@module之下 |
| @class | 標示一個類或一個函數(shù) |
| @constructor | 當(dāng)使用對象字面量形式定義類時，可使用此標簽標明構(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 | 標識此對象將會被導(dǎo)出到外部調(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ū)Ы坛痰逆溄?/td> |
| @see | 標簽允許您引用可能與被記錄的相關(guān)的另一個符號或資源 |
sublime+DocBlockr
/** Tab(回車)自動生成注釋
在注釋中回車自動生成 *
輸入@會自動提示標準注釋的標簽
文檔輸出YUIDoc
不解析文本，完全按照注釋標簽進行生成文檔，與代碼分離
NodeJs環(huán)境
npm install –g yuidocjs使用
在相應(yīng)的目錄下輸入 yuidoc . ，會在當(dāng)前目錄生成 out文件，里面生成注釋文檔
在相應(yīng)的目錄下輸入 yuidoc . –server
更多標簽可參考：
YUIDoc
JsDoc
編寫Js注釋以 /* 開頭，/ 結(jié)束
按照層級格式編寫：@module,[@sumodule],@class,@method,@property等層級格式
@method，@property，@param等必須在@class下面
每個標簽快里面只能包含下面一個標簽，描述了當(dāng)前代碼塊的作用。
@module 標簽描述一組關(guān)聯(lián)的類（對于JS 沒有類，YUIDoc只是把有構(gòu)造方法也歸為類罷了）。
@class標簽專門描述類的。在YUI庫中通常是個構(gòu)造函數(shù)。每個有@class 標簽的注釋塊都應(yīng)該有一個@static 或者 @constructor的副標簽。
@method 描述類中的方法。你將會用到 @return 和 @params 副標簽加以說明。
@property 描述類中的屬性
@event 描述你自定義的可觸發(fā)事件。YUIDoc文檔里指出
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/95139.html
摘要：本文比較了種較為主流的注釋文檔生成工具。應(yīng)該說是非常適合開源項目多個作者共同維護的一個文檔工具。最后我選擇了作為文檔生成的工具。為了支持多種語言，它僅對注釋塊內(nèi)部的內(nèi)容進行解析。 最近隨著寫Node以及獨立的CommonJS模塊越來越多，我發(fā)現(xiàn)有一份好的文檔不僅可以幫助自己在應(yīng)用這些接口的時候不至于迷糊，而且對于共同開發(fā)的情況下，能夠省去大量團隊的交流和Debug的時間。 本文比較了...
摘要：所有關(guān)于的推薦文章中，都提到了自身配有的一個小工具。說到底還是為了方便實驗以及實驗對的使用，并沒有過多考慮實際生產(chǎn)環(huán)境中的效率問題。 關(guān)于不同的Javascript文檔生成工具，可以參考我之前寫的一篇文章《Javascript自動化文檔工具：YUI Doc, JSDoc 3, JSDuck等比較》。本文中則要講講如何能夠基于Gulp構(gòu)建一個快速幫你預(yù)覽對應(yīng)注釋所生成文檔的小工具。 所...
摘要：我們在對現(xiàn)在較主流的五個文檔工具分別作了調(diào)研和嘗試，得到結(jié)論如下工具優(yōu)點缺點提供了完整的模板開發(fā)事件觸發(fā)等接口，使用非常靈活。至此，的環(huán)境部署已經(jīng)全部完成了。 字數(shù)：981 閱讀時間：5分鐘 選型依據(jù) ? 在經(jīng)歷了數(shù)個上線的項目之后，筆者所在的團隊已經(jīng)沉淀了一個相對穩(wěn)定版本的前端框架。因此，我們需要出具一套框架API文檔，以便公司其他成員的使用和框架的后期維護。我們在對...
摘要：組件的選擇命令行工具首先我們需要一個命令行工具來方便的執(zhí)行命令，這里我們選擇組件，如果不喜歡使用且有能力的人完全可以通過組件自己封裝執(zhí)行命令函數(shù)。 對于一個成熟的項目而言，一定需要一個注釋文檔生成工具，我們有很多可選的開源項目，如jsdoc、yuidocjs 等等，擁有這些強大的工具我們完全可以勝任任何注釋方面的管理了么？ 一個成熟的開發(fā)者都會知道不管怎么樣的項目都會在不同的開發(fā)條件下...
摘要：包含描述與指定所有參數(shù)和返回值的類型和值的注釋標簽。返回值的類型和描述或者更多示例更多請參考以下網(wǎng)站為本文參考，歡迎留言糾正。注解注釋原文代碼注釋規(guī)范與示例注釋 JavaScript代碼注釋范例 做為一個有情懷的Coder，最近收集了一下JavaScript代碼注釋范例，希望能夠幫助大家擼得一手妖媚而又放蕩的Bug。 普通注釋 單行注釋 使用 // 作為單行注釋。 單行注釋符后與注釋內(nèi)...
閱讀 2241·2021-09-22 15:25
閱讀 3620·2019-08-30 12:48
閱讀 2210·2019-08-30 11:25
閱讀 2342·2019-08-30 11:05
閱讀 728·2019-08-29 17:28
閱讀 3291·2019-08-26 12:16
閱讀 2614·2019-08-26 11:31
閱讀 1713·2019-08-23 17:08
