苏州工业园区质安监站网址,东莞设计网站,网址大全最安全实用的网址,常州做网站公司有哪些【强制】类、类属性、类方法的注释必须使用 Javadoc 规范#xff0c;使用/**内容*/格式#xff0c;不得使用
// xxx 方式。
说明#xff1a;在 IDE 编辑窗口中#xff0c;Javadoc 方式会提示相关注释#xff0c;生成 Javadoc 可以正确输出相应注释#xff1b;在 IDE
中…【强制】类、类属性、类方法的注释必须使用 Javadoc 规范使用/**内容*/格式不得使用
// xxx 方式。
说明在 IDE 编辑窗口中Javadoc 方式会提示相关注释生成 Javadoc 可以正确输出相应注释在 IDE
中工程调用方法时不进入方法即可悬浮提示方法、参数、返回值的意义提高阅读效率。 【强制】所有的抽象方法包括接口中的方法必须要用 Javadoc 注释、除了返回值、参数、
异常说明外还必须指出该方法做什么事情实现什么功能。
说明对子类的实现要求或者调用注意事项请一并说明。 【强制】所有的类都必须添加创建者和创建日期。 【强制】方法内部单行注释在被注释语句上方另起一行使用//注释。方法内部多行注释
使用/* */注释注意与代码对齐。 【强制】所有的枚举类型字段必须要有注释说明每个数据项的用途。 【推荐】与其“半吊子”英文来注释不如用中文注释把问题说清楚。专有名词与关键字保
持英文原文即可。
反例“TCP 连接超时”解释成“传输控制协议连接超时”理解反而费脑筋。 【推荐】代码修改的同时注释也要进行相应的修改尤其是参数、返回值、异常、核心逻
辑等的修改。
说明代码与注释更新不同步就像路网与导航软件更新不同步一样如果导航软件严重滞后就失去了
导航的意义。 【参考】谨慎注释掉代码。在上方详细说明而不是简单地注释掉。如果无用则删除。
说明代码被注释掉有两种可能性1后续会恢复此段代码逻辑。2永久不用。前者如果没有备注信
息难以知晓注释动机。后者建议直接删掉代码仓库已然保存了历史代码。 【参考】对于注释的要求第一、能够准确反映设计思想和代码逻辑第二、能够描述业务
含义使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者
形同天书注释是给自己看的即使隔很长时间也能清晰理解当时的思路注释也是给继
任者看的使其能够快速接替自己的工作。 【参考】好的命名、代码结构是自解释的注释力求精简准确、表达到位。避免出现注释的
一个极端过多过滥的注释代码的逻辑一旦修改修改注释是相当大的负担。
反例
// put elephant into fridge
put(elephant, fridge);
方法名 put加上两个有意义的变量名 elephant 和 fridge已经说明了这是在干什么语义清晰的代
码不需要额外的注释。
