成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

每一位JSer都應當掌握的注釋標記

Salamander / 617人閱讀

摘要：表示該函數(shù)接受可變數(shù)量的參數(shù)，并指定一個類型的參數(shù)一個可選參數(shù)可選參數(shù)，默認值指示參數(shù)是可選的。一個注釋塊中您可以包含多個標簽。

簡介

注釋標簽在代碼注釋中的作用非常大，但是可能很多同學在平常開發(fā)中會忽略這些標簽的作用，所以我這邊特地整理一些常用的注釋標記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個注釋標簽的作用.

想必掌握這些注釋標簽之后，不光對您今后的自己代碼編寫，還是閱讀優(yōu)秀源碼，都會帶來一定幫助.

或許你離漂亮的代碼，就差一個標簽^_^

項目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript

Egg源碼中大量注釋標記

常用標簽 @abstract

@abstract : 被此標記標識的成員方法，必須在繼承成員的對象中實現(xiàn)。

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/abstract

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

別名 : @virtual

概述

該成員（一般指父類的方法）必須在繼承的子類中實現(xiàn)（或重寫）。

語法 
@abstract
標簽效果

@constructor

@constructor : 被constructor標記的方法會被視為構(gòu)造函數(shù).

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/constructor

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

語法 
@class [ ]
別名

@class

標簽效果

@deprecated

@deprecated : 被此標記的函數(shù)或者成員方法表示下個版本將會被廢棄，告知適用方不再推薦使用此方法.

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/deprecated

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

語法 
@deprecated []
描述

如果被標記的方法只是因為被其他新方法代替而被廢棄，可以結(jié)合@see來表示被代替的方法

標簽效果 廢棄標簽

搭配@see

@inheritdoc

@inheritdoc : 指明這個標識應繼承其父類的文檔。

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/inheritdoc

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

語法 
@inheritdoc
標簽效果

@member

@member : 可以為某個成員變量定義類型.可以選擇性為成員變量指定名稱。

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/member

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

別名

@var

語法 
@member [] []
type類型 type基礎(chǔ)類型
類型 說明
string 字符串
Array or Type[] 數(shù)組
number 數(shù)字
Object 對象
Class 自定義的類名
Function 方法類型
null -
* 任意類型
type格式
類型名 語法示例 描述
Symbol name {boolean}
{myNamespace.MyClass}		 指定符號的名稱。 如果標識符已經(jīng)被文檔化，JSDoc將創(chuàng)建一個鏈接到該標識符的文檔
Multiple types {number|boolean}
表示數(shù)字或布爾		 這意味著值可能是幾種類型中的一種，并用|分隔類型的完整列表。
Arrays {Array.string} or string[]
表示字符串數(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ù)，默認值=1		 指示參數(shù)是可選的。當使用JSDoc的語法表示可選參數(shù)時，你還可以指明參數(shù)的默認值。
標簽效果

@param

@param : 標簽提供了對某個函數(shù)的參數(shù)的各項說明，包括參數(shù)名、參數(shù)數(shù)據(jù)類型、描述等。

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/param

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

語法 
@param {type} {name} {desc}
概述

@param標簽要求您指定要描述參數(shù)的名稱。您還可以包含參數(shù)的數(shù)據(jù)類型，使用大括號括起來，和參數(shù)的描述。

類型表達式可以有以下幾種表達形式

標識符的namepath(例如，myNamespace.MyClass)

一個內(nèi)置的javascript類型(如string, number)

以上兩種的組合

標簽效果 函數(shù)入?yún)⒍x類型

函數(shù)的入?yún)⑹且粋€對象，可以定義入?yún)ο髮傩灶愋?/b>

@see

@see : 此標簽表示可以參考另一個標識符的說明文檔，或者一個外部資源。

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/see

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

語法

@see

@see

標簽效果

動圖演示內(nèi)容

通過@see標記的{Foo#bar}，可以進行跳轉(zhuǎn)到Foo類中的bar成員屬性中

通過點擊@see標記的外部鏈接http://www.baidu.com，可跳轉(zhuǎn)到瀏覽器中查看

@throws

@throws : 說明可能會被拋出什么樣的錯誤。

詳細代碼演示 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript/throws

此標簽推薦使用PhpStorm/WebStorm進行閱讀,可以能直觀體現(xiàn)標簽的作用

語法

@throws free-form description

@throws {}

@throws {} free-form description

概述

@throws標簽可以讓你描述函數(shù)可能會拋出的錯誤。一個注釋塊中您可以包含多個@throws標簽。

Example 
/**
 * @description 拋出指定錯誤類型的錯誤
 * @throws {SQLException}
 */
function tagThrows1() {
}

/**
 * @throws SQL Execute failed
 */
function tagThrows2() {
}

/**
 * @throws {SQLException} SQL Execute failed.
 */
function tagThrows3() {
}
最后

文章篇幅有限，這里列舉了一部分標簽，更多標簽可以通過以下工程地址

項目工程地址 : https://github.com/yinggaozhen/doc-demo/tree/master/javascript

標簽會不定期持續(xù)更新，歡迎各位star & fork

您的支持是我更新的最大動力~~

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/104960.html

相關(guān)文章

  • 每個PHPer都應當掌握的注釋標記

    摘要：簡介注釋標簽在代碼注釋中的作用非常大，但是可能很多同學在平常開發(fā)中會忽略這些標簽的作用，所以我這邊特地整理一些常用的注釋標記，通過圖文展現(xiàn)形式，希望能幫助你能更好理解每個注釋標簽的作用或許你離漂亮的代碼，就差一個標簽項目工程地址被此標記的 簡介 注釋標簽在代碼注釋中的作用非常大，但是可能很多同學在平常開發(fā)中會忽略這些標簽的作用，所以我這邊特地整理一些常用的注釋標記，通過圖文展現(xiàn)形式，希...

    quietin 評論0 收藏0

  • 通用 CSS 筆記、建議與指導

    摘要：如下區(qū)塊標題前綴可以讓我們使用命令查找標題名時將搜索范圍限制在區(qū)塊標題中。 在參與規(guī)模龐大、歷時漫長且參與人數(shù)眾多的項目時，所有開發(fā)者遵守如下規(guī)則極為重要： 保持 CSS 易于維護 保持代碼清晰易懂 保持 CSS 的可拓展性 為了實現(xiàn)這一目標，我們要采用諸多方法。 本文檔第一部分將探討語法、格式以及分析 CSS 結(jié)構(gòu)；第二部分將圍繞方法論、思維框架以及編寫與規(guī)劃 CSS 的看法...

    lushan 評論0 收藏0

  • 如何成為一位「不那么差」的程序員

    摘要：能理解線程模型多線程優(yōu)缺點以及如何避免。多線程的出現(xiàn)主要是為了提高的利用率任務的執(zhí)行效率。所以要考慮清楚是否真的需要多線程。這一塊的內(nèi)容可以然我們知道寫大牛處理并發(fā)的思路，對我們自己編寫高質(zhì)量的多線程程序也有很多幫助。 showImg(https://segmentfault.com/img/remote/1460000015980196?w=2048&h=1363); 前言 已經(jīng)記不...

    caspar 評論0 收藏0

  • 幾個前端工程師應當掌握的“詞語”

    摘要：學堂碼匠各類前端術(shù)語知多少有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。 HTML5學堂-碼匠：W3C、BFC、FOUC、Hack、GPU、Sprite、UA……各類前端術(shù)語知多少？ 有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。明確一下這些詞語和概念沒有什么不好~一方面能夠讓自己能夠更專業(yè)的談論知識，另一方面，在...

    shusen 評論0 收藏0

  • 幾個前端工程師應當掌握的“詞語”

    摘要：學堂碼匠各類前端術(shù)語知多少有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。 HTML5學堂-碼匠：W3C、BFC、FOUC、Hack、GPU、Sprite、UA……各類前端術(shù)語知多少？ 有不少前端開發(fā)工程師，可能并不清楚下面的部分詞語，但是在實戰(zhàn)中其實都在使用著它們。明確一下這些詞語和概念沒有什么不好~一方面能夠讓自己能夠更專業(yè)的談論知識，另一方面，在...

    Bowman_han 評論0 收藏0

發(fā)表評論

0條評論

最新活動
閱讀需要支付1元查看
<