双人项目代码规范

该课程的双人项目与朱少文同学合作，通过对软件工程导论这门课的学习，让我意识到代码规范的重要性。

 

 

一命名规范

 

1：方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。

 

正例: localValue / getHttpMessage() / inputUserId

 

2：杜绝完全不规范的缩写,避免望文不知义

 

反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性

 

二常量定义

 

1：常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字

 

长。

 

正例:MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

 

反例:MAX_COUNT / EXPIRED_TIME

 

 

 

三代码格式

 

1：如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格;如果是非空代码块则:

 

1) 左大括号前换行

 

2) 左大括号后换行

 

3) 右大括号前换行

 

4) 右大括号后换行

 

2：if/for/while/switch/do 等保留字与括号之间都必须加空格

 

 

 

四OOP 规约

 

1：避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可

 

2：类成员与方法访问控制从严

 

1) 如果不允许外部直接通过 new 来创建对象,那么构造方法必须是 private

 

2) 类非 static 成员变量并且仅在本类使用,必须是 private

 

3) 类 static 成员变量如果仅在本类使用,必须是 private

 

4) 若是 static 成员变量,考虑是否为 final

 

5) 类成员方法只供类内部调用,必须是 private

 

说明:任何类、方法、参数、变量,严控访问范围。过于宽泛的访问范围,不利于模块解耦。思考:如果是一个 private 的方法,想删除就删除,可是一个 public 的 service 成员方法或成员变量,删除一下,不得手心冒点汗吗?变量像自己的小孩,尽量在自己的视线内,变量作用域太大,无限制的到处跑,那么你会担心的。

 

 

 

五注释规范

 

1：类、类方法的注释必须使用/**内容*/格式,不得使用// xxx 方式