结对作业之代码规范

结对作业之代码规范

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

• 为了更好的完成本次作业，经与队友讨论，并参考《构建之法》，故制定以下代码规范。

• 总原则：代码应该简明、易读、无二义性。

缩进

• 为了取消不同平台上的tab键的区别，故选择缩进为四个空格。

段行和花括号的格式

• 使用如下格式：

if(i>k)
{
    add addtion;
} 

     命名

• 为了使变量名与函数名方便理解以及使用，故采用一下方式命名:
• 凡是函数都取其功能英文命名，且各单词第一个字母大写，如：AddToTable
• 所有也取其代表的英文命名，采用驼峰式命名，即第一个单词小写，后面单词首字母大写，如：addToTable

注释

• 任何一个傻瓜都会写能够让机器理解的代码，只有好的程序员才能写出人类可以理解的代码。——Martin Fowle

• 立志要成为一个好的程序员，所以代码的目的不仅是完成功能，还要便于理解，所以添加注释是必不可少的一环。本次结对作业注释采用方形注释，在每次函数头部进行注释，如下：

/**
 * @class
 * @classdesc 这是对myClass类的描述
 * @desc 这是对myClass类的构造函数的描述
 */
function myClass() {
    ...
}