JAVA开发中协作规范之注释语句

1、类，类方法，类属性的方法请使用javadoc规范，使用/**内容*/格式，不要使用// *** 的方式图中是javadoc规范

2、在写抽象方法和接口中的方法时，请使用Javadoc注释，除了指明返回值，参数和异常说明外，还需要指出该方法在做什么事情，以及所实现的功能。

3、所有的类的注释中请添加创建者和创建日期，方便后期维护排查问题。

4、单行注释使用 ：在代码上方另起一行使用 //如果是多行注释， 使用/* */的方式，多用于介绍。

5、注释中不要中英混用，如果英文自己不擅长，是可以用中文注释把问题说清楚的。

6、修改的时候，也要记得更新注释，二者要保持同步更新；如果注释没跟上代码更新的脚步，那么注释本身就失去了意义。

7、注释尽量保持一个简练的风格。注释代码要慎重，如果是完全没用的，删除掉就好了，（后续不会选择再使用到的代码）