双人项目代码规范
通过对软件工程这门课的学习以及阅读老师发的两本代码规范的学习对接下来的双人项目的代码编写做了如下的简易规范:
1. 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
2. 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
3. 类名使用 UpperCamelCase 风格
4. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵 从驼峰形式。
5. 常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字 长。
6.抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类 命名以它要测试的类的名称开始,以 Test 结尾。
7. 类型与中括号紧挨相连来表示数组。
8. 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使 用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
9.避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,使可读性降低。
10.杜绝完全不规范的缩写,避免望文不知义。
11.为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。
12.在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。
13.如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
14.接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
通过学习,我认识到代码规则的重要性。大多数情况下,并非程序中有复杂的算法或是复杂的逻辑,而是去读别人的代码实在是一件痛苦的事情 。统一的风格使得代码可读性大大提高了,人们看到任何-段代码都会觉得异常熟悉。显然的,规范的代码在团队的合作开发中是非常有益而且必要的。我觉得老师分享的文件也让我更加深入思考,提高自己。
浙公网安备 33010602011771号