首页 > 代码库 > 代码整洁之道读后感(三)
代码整洁之道读后感(三)
注释
- 注释不能美化糟糕的代码
- 用代码来阐述你的思路
- 好的注释是什么?
- 法律信息
- 提供信息的注释
- 对意图的解释
- 警示:例如 // Don‘t run unless you have some time to kill
- TODO注释
- 公共API的JavaDoc
- 坏的注释是什么?
- 多余的注释
- 误导性的注释
- 循轨式注释:所谓每个函数都要有JavaDoc活每个变量都要有注释的规矩简直是愚蠢。这类注释只会让代码混乱不堪。
- 日志式注释
- 废话式注释: Default Constructor
- 信息过多:别再注释里什么都写,把细节描述都写出来。。。my God。
错误处理
- 尽量使用不可控异常
- 给出异常发生的环境说明
- 别返回Null值
- 别传递NUll值
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。