?

介紹

作用

合作分享：方便他人閱讀，便于分享

沉淀總結(jié)：容易忘記代碼，自己總結(jié)沉淀

形式

1.// 雙斜杠

?

2．/**/斜杠星號(hào)

?

常用標(biāo)簽

標(biāo)簽	描述
@module	標(biāo)明當(dāng)前文件模塊，在這個(gè)文件中的所有成員將被默認(rèn)為屬于此模塊，除非另外標(biāo)明
@submodule	針對(duì)模塊的劃分，處于@module之下
@class	標(biāo)示一個(gè)類或者一個(gè)函數(shù)
@constructor	當(dāng)使用對(duì)象字面量形式定義類時(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)表示。
@constant	常量標(biāo)識(shí)
@member/@var	記錄一個(gè)基本數(shù)據(jù)類型的成員變量
@method	標(biāo)記一個(gè)方法或函數(shù)
@param	標(biāo)記方法參數(shù)及參數(shù)類型
@property	標(biāo)明一個(gè)對(duì)象的屬性
@readonly	只讀
@return	標(biāo)明返回值、類型及描述
@type	描述代碼變量的類型
@description	如果在注釋開(kāi)始描述可省略此標(biāo)簽
@enum	一個(gè)類中屬性的類型相同時(shí)，使用此標(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è)鏈接，如 `{@link http://github.com Github}`
@name	指定一段代碼的名稱，強(qiáng)制 JSDoc 使用此名稱，而不是代碼里的名稱
@namespace	指定一個(gè)變量為命名空間變量
@static	描述一個(gè)不需實(shí)例即可使用的變量
@summary	對(duì)描述信息的短的概述
@throws	描述方法將會(huì)出現(xiàn)的錯(cuò)誤和異常
@todo	描述函數(shù)的功能或任務(wù)
@tutorial	插入一個(gè)指向向?qū)Ы坛痰逆溄?/p>

更多標(biāo)簽可參考

http://yui.github.io/yuidoc/syntax/index.html

http://usejsdoc.org/

開(kāi)發(fā)工具

sublime+DocBlockr

?

?

/** Tab(回車)自動(dòng)生成注釋

?

在注釋中回車自動(dòng)生成 *

?

輸入@會(huì)自動(dòng)提示標(biāo)準(zhǔn)注釋的標(biāo)簽

?

文檔輸出

YUIDoc

不解析文本，完全按照注釋標(biāo)簽進(jìn)行生成文檔，與代碼分離

NodeJs環(huán)境

https://nodejs.org/download/?下載node.js

?

安裝YUIDoc

npm install –g yuidocjs

?

使用

在相應(yīng)的目錄下輸入 yuidoc . ，會(huì)在當(dāng)前目錄生成 out文件，里面生成注釋文檔

?

在相應(yīng)的目錄下輸入 yuidoc . –server <port>，會(huì)使用nodejs環(huán)境生成對(duì)應(yīng)的網(wǎng)站

?

編寫(xiě)Js注釋

l? 以 /** 開(kāi)頭，*/ 結(jié)束

l? 按照層級(jí)格式編寫(xiě)

@module,[@sumodule], @class,@method,@property等層級(jí)格式

l? @method，@property，@param等必須在@class下面

l? 每個(gè)標(biāo)簽快里面只能包含下面一個(gè)標(biāo)簽，描述了當(dāng)前代碼塊的作用。

@module 標(biāo)簽描述一組關(guān)聯(lián)的類（對(duì)，對(duì)，JS 沒(méi)有類，YUIDoc只是把有構(gòu)造方法也歸為類罷了）。

@class標(biāo)簽專門(mén)描述類的。在YUI庫(kù)中通常是個(gè)構(gòu)造函數(shù)。每個(gè)有@class 標(biāo)簽的注釋塊都應(yīng)該有一個(gè)@static 或者 @constructor的副標(biāo)簽。

@method 描述類中的方法。你將會(huì)用到 @return 和 @params 副標(biāo)簽加以說(shuō)明。

@property 描述類中的屬性

@event 描述你自定義的可觸發(fā)事件。YUIDoc文檔里指出:

轉(zhuǎn)載于:https://www.cnblogs.com/decode1234/p/11085003.html

總結(jié)

以上是生活随笔為你收集整理的js注释的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。