个人Java编码规范2

1.       源程序注释量必须在30％以上

2.       包的注释：写入一个名为 package.html 的HTML格式的说明文件放入包所在路径。包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。

3.       类和接口的注释放在class 或者 interface关键字之前，import 关键字之后。注释主要是一句话功能简述与功能详细描述。类注释使用“/**  */”注释方式

4.       类属性(成员变量)、公有和保护方法注释：写在类属性、公有和保护方法上面，注释方式为“/**  */”。

5.       公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、异常等。

 

---

对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。

注释应与其描述的代码相近，对代码的注释应放在其上方，并与其上面的代码用空行隔开，注释与所描述内容进行同样的缩排。

对于switch语句下的case语句，必须在每个case分支结束前加上break语句。

修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

注释的内容要清楚、明了，含义准确，防止注释二义性。

避免在注释中使用缩写，特别是不常用缩写。

对重载父类的方法必须进行@Override声明