Table of Contents

如果没有特别说明,可以参照Google或阿里的编码规范(文后附有下载地址)

参考资料:

文件命名

Java文件命名采用类名.java,例如Employee.java, EmployeeContact.java

代码命名规范

默认规则

标识符只采用字母、数字和下划线。

不同类型的标识符命名规则

文件格式化

文件格式化,采用IntelliJ IDEA或Eclipse默认的格式化风格,即Reformat Code功能自动实现的文件格式化。

代码之间需要用空行分隔的,仅空一行。

最佳实践

1.如果没有特殊情况,所有的异常捕获后,都需要处理,并记录到日志中,不能捕获后什么都不做 2.复杂逻辑可以先将逻辑分步写好,然后逐步实现,避免中途被其他事情干扰,需要重新拾取思路

JavaDoc

所有publicclassmethodenum等都需要加JavaDoc注释,除非方法或类名特别清晰,随便找个英语好的人一看就知道类和方法是什么意思,方法里面做了什么处理