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