第四章 注释

本文探讨了在软件开发过程中如何减少依赖于注释,提高代码本身的可读性和表达力。提出了对外提供的API需要有清晰的JavaDoc,而内部使用的API则应通过重构保持简洁,避免不必要的注释。同时强调了在敏捷开发模式下文档的重要性降低,建议直接阅读代码以获取最真实的信息。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

原则就是:

1、对外模块公共的API需要提供正确、规范的JavaDoc
2、自己模块使用的API,最好不用注释,因为代码一直在修改,在重构,可是注释却没有人维护。
      错误的注释或者坏的注释会带来巨大的损失。
3、所以要求我们写的代码具有足够的表达力,用代码代替注释。
4、自从敏捷开发以后,模块的说明文档已经不存在了。和注释一样,代码一直在改,在重构
     但是文档却没有,并且写文档会耗费大量的时间,所以呢,直接看代码,代码是最真实的信息
     是不会骗人的。
5、TOOO注释也不需要。
6、如果觉得心里没底,需要写注释,那么请想想,如何把代码写的更具有表达力。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值