JS代碼規範--怎麼寫一段整潔有可讀性的代碼(一)

前幾天被面試官吐槽代碼寫的實在不行
這幾天從幾個方面加強了一下,先是看了最嚴重的代碼規範問題,
這方面看了《編寫可維護的JavaScript》受益頗多

函數的註釋

各種編程語言中函數的註釋也是需要特別注意的,一般來說,目前我接觸的編程語言的函數註釋都採用了以下這種方法:

/**
         * @name: FunName
         * @param {type}  在這裏描述參數段作用
         * @return {type}
         * @Date: 2020-05-07 17:17:41
         * @LastEditors: royalKnight
         */

一般來說,純手打這一大長串的註釋是非常的令人頭疼的,我在這裏推薦一個VScode上的一款插件,安裝後按Ctrl+Alt+T就可以一鍵寫入註釋格式koroFileHeader
koroFileHeader插件

命名

變量

命名方法,一般有兩種:駝峯式和橫線分隔式
命名方式一定要統一,不然到後期維護一定是非常頭疼的問題
駝峯式樣式:
由小寫開始,之後的單詞都首字符大寫:

var anotherVariable
函數

對於函數的命名,也有自己的一套方法:
在函數的最開始,加上一些約定俗成的動詞:

動詞 含義
can 函數會返回一個布爾值
has 函數會返回一個布爾值
is 函數會返回一個布爾值
get 函數會返回一個非布爾值
set 函數會用來保存一個值

例如:

isEnable();
setName();
getName();
常量

對於常量的命名,一般使用全部大寫和下劃線來分隔

var MAX_COUNT=10;
var URL;
類(構造函數)

類,構造函數一般使用大寫字母開頭

function Person();
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章