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

 时间:2024-10-13 13:43:44

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

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

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

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

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

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

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

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

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

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

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

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

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

JAVA开发中协作规范之注释语句
  • JAVA项目中的协作规范之代码格式
  • JAVA项目中的协作规范之编码命名风格
  • java中代码的书写规范
  • 如何在 Xcode 中编写规范注释
  • Java开发编码规范:[6]代码编写规范方法
  • 热门搜索
    学历怎么填 wifi密码怎么改 飞鹤奶粉怎么样 邯郸怎么读 筷子用英语怎么说 斗兽棋怎么玩 为什么掉头发 汤的家常做法 推特怎么注册 after怎么读