結對做業之代碼規範

結對做業之代碼規範

• 古人言：工欲善其事，必先利其器。

• 爲了更好的完成本次做業，經與隊友討論，並參考《構建之法》，故制定如下代碼規範。

• 總原則：代碼應該簡明、易讀、無二義性。

  縮進

• 爲了取消不一樣平臺上的tab鍵的區別，故選擇縮進爲四個空格。

  段行和花括號的格式

• 使用以下格式：

if(i>k)
{
    add addtion;
}

     命名

• 爲了使變量名與函數名方便理解以及使用，故採用一下方式命名:
• 凡是函數都取其功能英文命名，且各單詞第一個字母大寫，如：AddToTable

• 全部也取其表明的英文命名，採用駝峯式命名，即第一個單詞小寫，後面單詞首字母大寫，如：addToTable

  註釋

• 任何一個傻瓜都會寫可以讓機器理解的代碼，只有好的程序員才能寫出人類能夠理解的代碼。——Martin Fowle

• 立志要成爲一個好的程序員，因此代碼的目的不只是完成功能，還要便於理解，因此添加註釋是必不可少的一環。本次結對做業註釋採用方形註釋，在每次函數頭部進行註釋，以下：

/**
 * @class
 * @classdesc 這是對myClass類的描述
 * @desc 這是對myClass類的構造函數的描述
 */
function myClass() {
    ...
}