JavaScript編碼命名規範及格式規範

變量

• 局部變量命名採用首字母小寫，其它單詞首字母大寫：

//推薦
var printContent = 'hello world' 
//不推薦，變量名意義不明確
var objext = {};
//不推薦，變量名以類型最爲前綴
var strName = 'Hello World'
//不推薦，變量名使用語義不明確的縮寫
var newAC = functiono(){}

接口

• 公有接口：首字母大寫
• 私有接口：首字母小寫

Reader.Content = function () {
    //私有變量
    var info, title;
    //私有方法
    var getContent = function () { };

    return {
        //公有屬性
        ContentInfo: info,
        //公有方法
        SetTitle: function (contentTitle) {
            title = contentTitle;
        }
    }
}

jQuery框架

• jQuery類型變量添加 $ 最爲前綴

var $tocTitle = $('.reader-toc-title');

空格

• 函數參數逗號,後面加空格
• 函數名後面不加空格
• 參數)和{之間有空格

function Partition(data, length, start, end) {
}

• for 循環中的;後面加空格

for (var i = 0; i < 10; i++)

• = < 等操做符先後加空格

while (x == y)

• for while 等後面加空格

註釋

• 單行註釋 //，單獨佔一行，不要寫在代碼後面
• 多行註釋/* */

/* 文件頭部信息註釋 */
/*!
 * reader content v1.0
 *
 * Copyright 2018
*/

其它

• 字符串使用單引號，由於HTML中使用雙引號

var content = '<sapn id="main_content"> ...';

• 左大括號不要另起一行，

for(var i = 0; i < 10; i ++){
}

• 即便邏輯只有一行也要用大括號括起來

if(false){
  return true;
}

• 語句結束時添加分號;
• JavaScript有自動插入分號的算法，可是有缺陷

在沒有添加分號的語句結束處自動添加分號
除非下一行以[、(、+、-、/開頭則不添加分號

• 因爲自動添加分號致使錯誤

return 
{
  a + b
}

等價於

return ;
{
  a + b
}

能夠經過將(不另起一行解決

• 因爲沒有在該添加分號處添加致使錯誤

var b = function()
var a = b
(function()
)()

等價於

var a = b(function())()

---

參考： 《Web前端開發最佳實踐》