快捷導(dǎo)航

JavaScript如何正確的寫(xiě)代碼注釋

更新時(shí)間：2023年10月07日 15:35:50 作者：堅(jiān)毅的小解同志

這篇文章主要給大家介紹了關(guān)于JavaScript如何正確的寫(xiě)代碼注釋的相關(guān)資料,注釋的作用是提高代碼的可讀性,幫助自己和別人閱讀和理解你所編寫(xiě)的JavaScript代碼,注釋的內(nèi)容不會(huì)在網(wǎng)頁(yè)中顯示,需要的朋友可以參考下

錯(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)容多了那么/* */段落注釋同樣也可以寫(xiě)，那么它還有什么優(yōu)點(diǎn)呢？