JavaScript如何正確的寫代碼注釋
錯(cuò)誤注釋
你的注釋是不是這樣的？
//時(shí)間戳日期格式化函數(shù)
function formTime(time,isyear){
}亦或者是這樣的？
/*
時(shí)間戳日期格式化函數(shù)
*/
function formTime(time,isyear){
}簡(jiǎn)單的變量聲明之類的內(nèi)容可以進(jìn)行簡(jiǎn)單注釋，但是函數(shù)就不能這樣做了，要知道注釋的作用是一種為了讓代碼更易讀、易維護(hù)、易理解，起到提示的作用的，上面的兩個(gè)注釋都是正確的，但是它起到的作用太低了，在正式工作中我們往往會(huì)協(xié)同開(kāi)發(fā)，這種注釋是萬(wàn)萬(wàn)不可的。
正確注釋
正確的注釋 就是文檔注釋，先來(lái)看看是什么樣子。
/**
* @author 小解同志 https://lamian.blog.csdn.net
* @param {String} time 接受用戶傳來(lái)的時(shí)間戳
* @param {Boolean} isyear 是否要顯示年月日
* @example formTime('3434322332',true) 格式化時(shí)間戳并顯示年月日
*/
function formTime(time,isyear){
}是不是比之前的注釋多了很多，內(nèi)容詳細(xì)了很多，當(dāng)然，不只是單單的內(nèi)容多了，如果只是內(nèi)容多了那么/* */段落注釋同樣也可以寫，那么它還有什么優(yōu)點(diǎn)呢？
優(yōu)點(diǎn)
方法提示
time是個(gè)字符串 我們要截取字符串
普通注釋
文檔注釋
內(nèi)容提示
鼠標(biāo)移動(dòng)到函數(shù)以及參數(shù)上所給的提示。
普通注釋
文檔注釋
這種提示就像嵌代碼在里面一樣，而不是浮于表面了，在我們書(shū)寫npm包的時(shí)候，用戶使用我們的包，就能看到這種提示，對(duì)使用者特別友好。
自動(dòng)化生成文檔
既然叫文檔注釋，那么生成個(gè)文檔也沒(méi)什么好奇怪的吧，生成文檔的包有很多種，比如jsDoc，apiDoc等等，在這里我使用jsdoc。
安裝
輸入以下命令進(jìn)行全局安裝。
npm install jsdoc -g
基本使用
jsdoc 文件名 其他的使用方式可以去官網(wǎng)查看
jsdoc 33.js
執(zhí)行完此命令，會(huì)生成一個(gè)out文件夾，查看里面的index頁(yè)面即可，右邊側(cè)邊欄會(huì)顯示函數(shù)的使用
總結(jié)
到此這篇關(guān)于JavaScript如何正確的寫代碼注釋的文章就介紹到這了,更多相關(guān)js正確寫代碼注釋內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要介紹了獲取XMLHttpRequest對(duì)象的三種方式,需要的朋友可以參考下2014-04-04
微信小程序?qū)崿F(xiàn)tab組件切換動(dòng)畫(huà)
tab相對(duì)而言用的還是比較多的,但是用起來(lái)并沒(méi)有難,下面這篇文章主要給大家介紹了關(guān)于微信小程序全局配置之tab的相關(guān)資料,文中通過(guò)圖文以及示例代碼介紹的非常詳細(xì),需要的朋友可以參考下2022-10-10
這篇文章主要是對(duì)JavaScript中的隱式類型轉(zhuǎn)換進(jìn)行了詳細(xì)分析介紹，需要的朋友可以過(guò)來(lái)參考下，希望對(duì)大家有所幫助2013-12-12
在JavaScript中模擬類(class)及類的繼承關(guān)系
眾所周知,JavaScript中沒(méi)有類,然而我們卻可以動(dòng)手實(shí)現(xiàn)一個(gè)擁有繼承特性的類,所以接下來(lái)我們要討論的便是在JavaScript中模擬類(class)及類的繼承關(guān)系:2016-05-05
這篇文章給大家羅列了在前段排序中會(huì)遇到的問(wèn)題并寫了解決方案，非常詳細(xì)，有需要的朋友可以參考。2016-07-07
徹底搞懂JS中call、apply、bind的區(qū)別與應(yīng)用
在JavaScript中函數(shù)執(zhí)行時(shí)的this值默認(rèn)由調(diào)用方式?jīng)Q定,但可通過(guò)call、apply和bind方法顯式控制,這三種方法的核心功能均為修改this指向,但在執(zhí)行時(shí)機(jī)、參數(shù)傳遞和返回值上存在差異,這篇文章主要介紹了JS中call、apply、bind區(qū)別與應(yīng)用的相關(guān)資料,需要的朋友可以參考下2026-04-04
Bootstrap警告（Alerts）的實(shí)現(xiàn)方法
這篇文章主要為大家詳細(xì)介紹了Bootstrap警告（Alerts）的實(shí)現(xiàn)方法，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-03-03
本文主要介紹了javascript七種常見(jiàn)算法：冒泡排序；插入排序；希爾排序；歸并排序；快速排序；選擇排序；奇偶排序。具有一定的參考價(jià)值，下面跟著小編一起來(lái)看下吧2017-01-01
js微信應(yīng)用場(chǎng)景之微信音樂(lè)相冊(cè)案例分享
這篇文章主要為大家分享了js微信應(yīng)用場(chǎng)景之微信音樂(lè)相冊(cè)案例，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-08-08
JS獲取input file絕對(duì)路徑的方法(推薦)
下面小編就為大家?guī)?lái)一篇JS獲取input file絕對(duì)路徑的方法(推薦)。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-08-08