在程序员的世界里有两件最讨厌的事情,第一件事情是讨厌写代码注释,第二件事情是讨厌看别人的代码不写注释。虽然这只是个段子,但也反映了当下很多程序员的心声。下面简单介绍下代码规范的重要性,第一,规范的代码可以促进团队合作,第二,规范的代码可以减少bug处理,第三,规范的代码可以降低维护成本,第四,规范的代码有助于代码审查,第五,养成代码规范的习惯,有助于程序员自身的成长。
本系列文章将整合 阿里巴巴《Java开发手册》 和 谷歌《Java编程规范》 ,总结Java开发过程的编码规范,并通过具体编码案例给出编码规范的原因,如果总结内容存在问题还望指出。
目录
上一篇 《Java开发规范之代码格式篇(上)》 介绍了括号换行和空格等注意事项,本文将继续介绍字符限制和方法格式等内容。IDEA中可以配置格式化模板,使用快捷键ctrl+alt+L即可一键格式化代码,具体路径请参考 File - Settings - Editor - Code Style - Java - Scheme,点击齿轮图标导入配置文件即可,点击下载idea的Java格式化模板 。
6.单行字符数限制和自动行号准则
Alibaba规约(强制)
单行字符数限制不超过120个,超出需要换行,换行时遵循如下原则:
- 第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进,参考示例。
- 运算符与下文一起换行。
- 方法调用的点符号与下文一起换行。
- 方法调用中的多个参数需要换行时,在逗号后进行。
- 在括号前不要换行。
Google规约
一个项目可以选择一行80个字符或100个字符的列限制,除了下述例外,任何一行如果超过这个字符数限制,必须自动换行。
- 不可能满足列限制的行(例如,Javad