最美情侣中文字幕电影,在线麻豆精品传媒,在线网站高清黄,久久黄色视频

歡迎光臨散文網(wǎng) 會(huì)員登陸 & 注冊(cè)

如何給一個(gè) JS 函數(shù)添加注釋

2023-03-31 10:56 作者:笨鳥(niǎo)問(wèn)答錄  | 我要投稿

一、js 函數(shù)注釋可以采用 JSDoc 標(biāo)準(zhǔn),格式如下:

二、可能你的參數(shù)需要支持過(guò)多類(lèi)型,可以使用 | 符合進(jìn)行分割:

三、可能你的參數(shù)類(lèi)型復(fù)雜,你不知道怎么寫(xiě),下面我將常用類(lèi)型都列出來(lái):

  • {number}?表示一個(gè)數(shù)字類(lèi)型值

  • {string}?表示一個(gè)字符串類(lèi)型值

  • {boolean}?表示一個(gè)布爾類(lèi)型值

  • {Object}?表示一個(gè)對(duì)象類(lèi)型值

  • {Array}?表示一個(gè)數(shù)組類(lèi)型值

  • {function}?表示一個(gè)函數(shù)類(lèi)型值

  • {Class}?表示一個(gè)類(lèi)類(lèi)型值

  • {undefined}?表示一個(gè) undefined 值

  • {null}?表示一個(gè) null 值

  • {any}?表示任意類(lèi)型值,不進(jìn)行類(lèi)型檢查

  • {Promise}?表示一個(gè) Promise 類(lèi)型對(duì)象

  • {Iterable}?表示可以迭代的對(duì)象類(lèi)型

  • {Iterator}?表示一個(gè)迭代器類(lèi)型對(duì)象

  • {Generator}?表示一個(gè) Generator 函數(shù)類(lèi)型

  • {RegExp}?表示一個(gè)正則表達(dá)式類(lèi)型

  • {Date}?表示一個(gè)日期類(lèi)型

  • {HTMLElement}?表示一個(gè) HTML 元素類(lèi)型

  • {Element}?表示一個(gè) DOM 元素類(lèi)型

四、可能你的參數(shù)是一個(gè)自定義的對(duì)象,那么可以這樣做,通過(guò) @typedef 關(guān)鍵字來(lái)自定義類(lèi)型:

五、如果,你多個(gè)函數(shù)公用一個(gè)數(shù)據(jù)類(lèi)型,甚至還可以全局定義:

我相信,以上能滿足你絕大多數(shù)的注釋要求。如果有跟多需求,可以參考JSDoc 官方文檔地址為:https://jsdoc.app/。

該網(wǎng)站提供了詳細(xì)的 JSDoc 使用文檔,包括標(biāo)簽的使用、類(lèi)型標(biāo)記、示例和配置等方面的內(nèi)容,同時(shí)也提供了許多示例和 API 參考等。你可以在該網(wǎng)站上了解和學(xué)習(xí)如何使用 JSDoc 編寫(xiě)規(guī)范的 JavaScript 文檔,并且在自己的 JavaScript 項(xiàng)目中應(yīng)用。


如何給一個(gè) JS 函數(shù)添加注釋的評(píng)論 (共 條)

分享到微博請(qǐng)遵守國(guó)家法律
汨罗市| 镇安县| 安化县| 五大连池市| 临夏县| 浦东新区| 涪陵区| 南郑县| 临漳县| 岗巴县| 兰西县| 泾川县| 澎湖县| 永宁县| 天门市| 甘洛县| 大同市| 沁阳市| 离岛区| 济南市| 株洲县| 当阳市| 大埔区| 莎车县| 大洼县| 连平县| 凤凰县| 安义县| 新乡县| 阳东县| 环江| 琼海市| 赤城县| 贞丰县| 宾阳县| 马山县| 迁西县| 永康市| 岱山县| 旌德县| 子洲县|