本文档的建立是为了适应团队开发和开发流程的统一,增加代码的强壮性、可读性和易维护性,让新的开发人员能迅速适应项目氛围。
1.所有文件统一用UTF-8编码。
通过“右击工程->属性->Resource->UTF-8”可以设置。
2.每行代码最多不得操作120个字。
可以在eclipse中设置:performance -> Java -> Code Style -> Formatter -> 以当前设置模板新建立一个自定义设置,然后把每行最大字符数改成120。
这样每次写完代码,直接用Ctrl+Shift+F格式化代码,然后再保存。
另外,字符串变量如果超过120个字,用 + 号组织(直接在字符串里按回车,会自动生成这种格式),如图示:
3.空行的使用
package块后空1行
import块后空1行
变量声明后需要空1行,如果需要分类区别,各类别之间空1行。
条件、循环,选择语句,整个语句结束,需要空1行。
各功能块之间空1行。
注释与代码之间不空行。
4.注释的使用
当你需要时,使用注释来解释一段特定的代码段的作用。注释必须保证更新或者及时删除。
单行注释用///
Javadoc多行注释用/** …… */
Javadoc多行注释可以包含一些HTML标记符和专门的关键词。使用Javadoc注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。
/**
* 注释描述
*
* @param p 参数说明
* @author 作者
* @version 版本及时间
*/
如图示:
5.标记的使用
在代码中,适当使用以下标记来定位和备注自己的工作
// MARK: 标记的原因说明
// TODO: 将来要做的是什么
// FIXME: 将来要修复什么
标记中,尽量跟上自己的名字
我们在打开代码时,点击右边滚动条上的蓝色小块即可定位这些标签内容,另外也可以打开Task视图,查看这些标记一览。
6.大括号的使用
方法定义的大括号或者其他大括号(if/else/switch/while等),一般都放在定义名称的同一行,并且使用一个新的行来结束,如图示:
7.SQL语句的使用
SQL语句中的关键字全部用大写,对于较长的嵌套查询,按层次进行换行。对于较多列的插入语句,按每列换行,如图示: