不写注释当然不太好,不仅仅是对公司,对自己也不好:
- 对自己,不写注释是非常不好的工作习惯,时间长了即便是自己写的代码也会忘记,后续再重构会很费劲,也会给领导和同事留下不好的印象;
- 对公司,代码是科技公司最重要的资产之一,如果不写注释,会造成很高的维护成本(特别是人员更替之后),对于公司肯定是不希望的。
关于注释的原则
- 一定要做注释,注释方便了代码维护,很有价值;
- 在项目开发中要尽量保持代码注释的规范性和统一性;
- 注释要保持简洁明确,一般不要出现无意义的形容词;
- 通过注释可以快速知道所写函数的功能,返回值,参数的使用;
- 边写代码边注释,修改代码时要相应修改注释,保证注释和代码的一致性。
关于注释的建议
PS. 下面部分建议源自网友分享,仅供参考。
1.【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用// xxx 方式。
说明:在 IDE 编辑窗口中,Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注释;在IDE中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。
2.【强制】所有的抽象方法 ( 包括接口中的方法 ) 必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必