資訊專欄INFORMATION COLUMN
摘要：表示該函數(shù)接受可變數(shù)量的參數(shù)，并指定一個類型的參數(shù)一個可選參數(shù)可選參數(shù)，默認(rèn)值指示參數(shù)是可選的。一個注釋塊中您可以包含多個標(biāo)簽。
簡介
注釋標(biāo)簽在代碼注釋中的作用非常大，但是可能很多同學(xué)在平常開發(fā)中會忽略這些標(biāo)簽的作用，所以我這邊特地整理一些常用的注釋標(biāo)記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個注釋標(biāo)簽的作用.
想必掌握這些注釋標(biāo)簽之后，不光對您今后的自己代碼編寫，還是閱讀優(yōu)秀源碼，都會帶來一定幫助.
或許你離漂亮的代碼，就差一個標(biāo)簽^_^
項目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript
Egg源碼中大量注釋標(biāo)記 常用標(biāo)簽 @abstract@abstract : 被此標(biāo)記標(biāo)識的成員方法，必須在繼承成員的對象中實現(xiàn)。
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/abstract
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
別名 : @virtual
概述該成員（一般指父類的方法）必須在繼承的子類中實現(xiàn)（或重寫）。
語法@abstract標(biāo)簽效果 @constructor
@constructor : 被constructor標(biāo)記的方法會被視為構(gòu)造函數(shù).
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/constructor
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
語法@class [別名]
@class
標(biāo)簽效果 @deprecated@deprecated : 被此標(biāo)記的函數(shù)或者成員方法表示下個版本將會被廢棄，告知適用方不再推薦使用此方法.
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/deprecated
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
語法@deprecated [描述]
如果被標(biāo)記的方法只是因為被其他新方法代替而被廢棄，可以結(jié)合@see來表示被代替的方法
標(biāo)簽效果 廢棄標(biāo)簽 搭配@see @inheritdoc@inheritdoc : 指明這個標(biāo)識應(yīng)繼承其父類的文檔。
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/inheritdoc
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
語法@inheritdoc標(biāo)簽效果 @member
@member : 可以為某個成員變量定義類型.可以選擇性為成員變量指定名稱。
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/member
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
別名@var
語法@member [type類型 type基礎(chǔ)類型] [ ]
| 類型 | 說明 |
|---|---|
| string | 字符串 |
| Array or Type[] | 數(shù)組 |
| number | 數(shù)字 |
| Object | 對象 |
| Class | 自定義的類名 |
| Function | 方法類型 |
| null | - |
| * | 任意類型 |
| 類型名 | 語法示例 | 描述 |
|---|---|---|
| Symbol name | {boolean} {myNamespace.MyClass} |
指定符號的名稱。 如果標(biāo)識符已經(jīng)被文檔化，JSDoc將創(chuàng)建一個鏈接到該標(biāo)識符的文檔 |
| Multiple types | {number|boolean} 表示數(shù)字或布爾 |
這意味著值可能是幾種類型中的一種，并用|分隔類型的完整列表。 |
| Arrays | {Array.string} or string[] 表示字符串?dāng)?shù)組 |
- |
| Objects | {name: string, age : number} or Object | - |
| Nullable type | 一個數(shù)字或null {?number} | 指明類型為指定的類型，或者為null。 |
| Non-nullable type | 一個數(shù)字，但是絕對不會是null {!number} | 指明類型為指定的類型，但是絕對不會是null。 |
| Variable number of that type | 此函數(shù)接受可變數(shù)量的數(shù)值參數(shù)。 @param {...number} num |
表示該函數(shù)接受可變數(shù)量的參數(shù)，并指定一個類型的參數(shù) |
| Optional parameter | 一個可選參數(shù) @param {number} [foo] @param {number} [foo=1] 可選參數(shù)，默認(rèn)值=1 |
指示參數(shù)是可選的。當(dāng)使用JSDoc的語法表示可選參數(shù)時，你還可以指明參數(shù)的默認(rèn)值。 |
@param : 標(biāo)簽提供了對某個函數(shù)的參數(shù)的各項說明，包括參數(shù)名、參數(shù)數(shù)據(jù)類型、描述等。
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/param
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
語法@param {type} {name} {desc}
概述
@param標(biāo)簽要求您指定要描述參數(shù)的名稱。您還可以包含參數(shù)的數(shù)據(jù)類型，使用大括號括起來，和參數(shù)的描述。
類型表達(dá)式可以有以下幾種表達(dá)形式
標(biāo)識符的namepath(例如，myNamespace.MyClass)
一個內(nèi)置的javascript類型(如string, number)
以上兩種的組合
標(biāo)簽效果 函數(shù)入?yún)⒍x類型 函數(shù)的入?yún)⑹且粋€對象，可以定義入?yún)ο髮傩灶愋?/b> @see@see : 此標(biāo)簽表示可以參考另一個標(biāo)識符的說明文檔，或者一個外部資源。
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/see
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
語法@see
@see
動圖演示內(nèi)容
通過@see標(biāo)記的{Foo#bar}，可以進(jìn)行跳轉(zhuǎn)到Foo類中的bar成員屬性中
通過點(diǎn)擊@see標(biāo)記的外部鏈接http://www.baidu.com，可跳轉(zhuǎn)到瀏覽器中查看
@throws@throws : 說明可能會被拋出什么樣的錯誤。
詳細(xì)代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/throws
此標(biāo)簽推薦使用PhpStorm/WebStorm進(jìn)行閱讀,可以能直觀體現(xiàn)標(biāo)簽的作用
語法@throws free-form description
@throws {
@throws {
@throws標(biāo)簽可以讓你描述函數(shù)可能會拋出的錯誤。一個注釋塊中您可以包含多個@throws標(biāo)簽。
Example/**
* @description 拋出指定錯誤類型的錯誤
* @throws {SQLException}
*/
function tagThrows1() {
}
/**
* @throws SQL Execute failed
*/
function tagThrows2() {
}
/**
* @throws {SQLException} SQL Execute failed.
*/
function tagThrows3() {
}
最后
文章篇幅有限，這里列舉了一部分標(biāo)簽，更多標(biāo)簽可以通過以下工程地址
項目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript
標(biāo)簽會不定期持續(xù)更新，歡迎各位star & fork
您的支持是我更新的最大動力~~
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://www.ezyhdfw.cn/yun/104960.html
摘要：簡介注釋標(biāo)簽在代碼注釋中的作用非常大，但是可能很多同學(xué)在平常開發(fā)中會忽略這些標(biāo)簽的作用，所以我這邊特地整理一些常用的注釋標(biāo)記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個注釋標(biāo)簽的作用或許你離漂亮的代碼，就差一個標(biāo)簽項目工程地址被此標(biāo)記的 簡介 注釋標(biāo)簽在代碼注釋中的作用非常大，但是可能很多同學(xué)在平常開發(fā)中會忽略這些標(biāo)簽的作用，所以我這邊特地整理一些常用的注釋標(biāo)記，通過圖文展現(xiàn)形式，希...
摘要：如下區(qū)塊標(biāo)題前綴可以讓我們使用命令查找標(biāo)題名時將搜索范圍限制在區(qū)塊標(biāo)題中。 在參與規(guī)模龐大、歷時漫長且參與人數(shù)眾多的項目時，所有開發(fā)者遵守如下規(guī)則極為重要： 保持 CSS 易于維護(hù) 保持代碼清晰易懂 保持 CSS 的可拓展性 為了實現(xiàn)這一目標(biāo)，我們要采用諸多方法。 本文檔第一部分將探討語法、格式以及分析 CSS 結(jié)構(gòu)；第二部分將圍繞方法論、思維框架以及編寫與規(guī)劃 CSS 的看法...
摘要：能理解線程模型多線程優(yōu)缺點(diǎn)以及如何避免。多線程的出現(xiàn)主要是為了提高的利用率任務(wù)的執(zhí)行效率。所以要考慮清楚是否真的需要多線程。這一塊的內(nèi)容可以然我們知道寫大牛處理并發(fā)的思路，對我們自己編寫高質(zhì)量的多線程程序也有很多幫助。 showImg(https://segmentfault.com/img/remote/1460000015980196?w=2048&h=1363); 前言 已經(jīng)記不...
摘要：學(xué)堂碼匠各類前端術(shù)語知多少有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。 HTML5學(xué)堂-碼匠：W3C、BFC、FOUC、Hack、GPU、Sprite、UA……各類前端術(shù)語知多少？ 有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。明確一下這些詞語和概念沒有什么不好~一方面能夠讓自己能夠更專業(yè)的談?wù)撝R，另一方面，在...
摘要：學(xué)堂碼匠各類前端術(shù)語知多少有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。 HTML5學(xué)堂-碼匠：W3C、BFC、FOUC、Hack、GPU、Sprite、UA……各類前端術(shù)語知多少？ 有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。明確一下這些詞語和概念沒有什么不好~一方面能夠讓自己能夠更專業(yè)的談?wù)撝R，另一方面，在...
閱讀 2937·2023-04-26 02:23
閱讀 1767·2021-11-11 16:55
閱讀 3212·2021-10-19 11:47
閱讀 3448·2021-09-22 15:15
閱讀 2044·2019-08-30 15:55
閱讀 1105·2019-08-29 15:43
閱讀 1360·2019-08-29 13:16
閱讀 2264·2019-08-29 12:38
