開發(fā)規(guī)范

???JavaScript代碼規(guī)范

代碼規(guī)范通常包括這幾個方面

  • 變量和函數(shù)的命名規(guī)則
  • 空格,縮進,注釋的使用規(guī)則。
  • 其他常用規(guī)范……

寫代碼應(yīng)該注意的事情

  1. 變量名聲明不一樣,不要使用相似或容易重復(fù)的變量名。
  2. 代碼中的命名必須字母開頭,字母結(jié)束,不能出現(xiàn)中文
  3. 盡量少使用縮寫。
  4. 不要隨便新增變量,僅在絕對必要時才添加新變量。

盡量遵循代碼規(guī)范

  • 遵從其中的一丟丟,你的代碼就會變得充滿驚喜。
  • 遵從其中的一大部分,你的代碼將真正成為你的代碼,沒有人會想改變它。
  • 遵從所有,你的代碼將成為尋求啟發(fā)的年輕開發(fā)者的寶貴案例。

命名

JavaScript命名應(yīng)遵循 簡潔、語義化 的原則。

變量名&常量名

變量 :

  • 變量小駝峰式命名法。
  • 全局變量全部大寫 。

常量:使用大寫字母和下劃線來組合命名,下劃線用來分割單詞。

let lastName; //變量
let COLOR; //全局變量
const CONSTANT; //常量大寫

函數(shù)&方法命名

函數(shù)&方法 :

  • 使用小駝峰式命名法。
  • 前綴應(yīng)該為動詞。
  • 建議常用動詞要約定好。
function getData() {} //獲取數(shù)據(jù)
代碼 輸出
can 判斷是否可執(zhí)行某個動作
has 判斷是否含義某個值
is 判斷是否為某個值
get 獲取某個值
set 設(shè)置某個值
load 加載某些數(shù)據(jù)

語句規(guī)則

簡單語句的通用規(guī)則:

  • 一條語句通常以分號作為結(jié)束符。
  • 將左花括號放在第一行的結(jié)尾。
  • 左花括號前添加一空格。
  • 將右花括號獨立放在一行。
  • 不要以分號結(jié)束一個復(fù)雜的聲明。

???git

Commit message

首先我們要了解一點——Commit message 的作用。

  • 目的很簡單就是為了提供更多的歷史信息,方便快速瀏覽。
  • 可以過濾某些commit(比如文檔改動),便于快速查找信息。
  • 為 Code Reviewing做準備。
  • 提高項目的整體質(zhì)量,提高個人工程素質(zhì)。
  • ......

提交commit 的時候,應(yīng)注意一下準則。

  • feat - 新增功能
  • fix - 修改內(nèi)容
  • fix - 修改內(nèi)容
  • close - 關(guān)閉 issue
  • clean -刪除內(nèi)容
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容