目标说明
统一良好的代码格式规范可以有效提升开发团队之间的「协作效率」,如果不同的开发团队或者开发人员采用不同的代码格式规范,那么每次Format代码都会导致大量的变化,在Code Review及Merge代码时会带来很多的干扰项。因此制定本代码规范希望达成以下目标:
统一Java代码格式规范,确保团队成员间「代码风格一致」;
保证Format代码时不会引入格式上的干扰;
提升团队协作效率、Code Review效率;
怎么实施
在Java代码规范方面目前Google Java Code Style在业界使用得比较广泛。它的优点如下:
业界比较通用;
有比较完善的自动化校验工具及checkstyle配置文档;
为了满足「代码的美感」,借鉴其他公司的定制经验,根据马蜂窝的内部需求,我们进行了一些小的定制,具体变化如下:
修改intellij-java-google-style.xml中的内容:
INDENT_SIZE 2 4 行缩进
TAB_SIZE 2 4 TAB缩进
CONTINUATION_INDENT_SIZE 4 8 换行缩进
RIGHT_MARGIN 100 120 单行的长度
JD_PRESERVE_LINE_FEEDS 无 true 注释中保留手动的换行
KEEP_LINE_BREAKS 无 true Java代码中,保留手动的换行
修改intellij-java-google-style.xml文件下载:
intellij-java-google-style.xml
使用方式
使用代码规范主要干两件事:
代码格式化,可以实现自动化的代码格式化操作