编程不写注释会怎么样?

不写注释对个人和公司都有负面影响,导致代码维护困难和高成本。注释应简洁明了,与代码同步更新,遵循Javadoc规范。良好的注释能提升代码可读性,方便团队协作和后续维护。
摘要由CSDN通过智能技术生成

不写注释当然不太好,不仅仅是对公司,对自己也不好

  • 对自己,不写注释是非常不好的工作习惯,时间长了即便是自己写的代码也会忘记,后续再重构会很费劲,也会给领导和同事留下不好的印象;
  • 对公司,代码是科技公司最重要的资产之一,如果不写注释,会造成很高的维护成本(特别是人员更替之后),对于公司肯定是不希望的。

关于注释的原则

  • 一定要做注释,注释方便了代码维护,很有价值;
  • 在项目开发中要尽量保持代码注释的规范性和统一性;
  • 注释要保持简洁明确,一般不要出现无意义的形容词;
  • 通过注释可以快速知道所写函数的功能,返回值,参数的使用;
  • 边写代码边注释,修改代码时要相应修改注释,保证注释和代码的一致性。

关于注释的建议
PS. 下面部分建议源自网友分享,仅供参考。

1.【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用// xxx 方式。

说明:在 IDE 编辑窗口中,Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注释;在IDE中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。

2.【强制】所有的抽象方法 ( 包括接口中的方法 ) 必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值