Clean Code(三):注释
2015-08-22 00:44
309 查看
在工作中经常在刚开始写代码的时候,写下类与方法的注释,时间久了,CR多了,也不可能一直去修改注释了。加班都累成dog。注释才不改呢,就是这么任性,哈哈。
项目久了,注释会欺骗阅读者,本人被骗过,也骗过别人。
注释只是一种代码的补充,如果方法,类,变量命名好的话,一般不需要注释,它并不能美化代码,丑陋的代码经过N次CR之后,除了开发者无人能懂,注释就变成了毒药。
一般下列注释还是可以的:
法律信息:只要有可能,就指向一份标准许可或其他外部文档,而不是把所有条款放到注释中
提供信息的注释:比如某个抽象方法的返回值,某个map参数中的键值
对意图的解释:就是为什么要这么做,对下面的代码带来了什么样的影响
阐释:把某种难明的参数或返回值,翻译为可读的形式
警示的注释
公共的API,这个我觉得一定要有。
项目久了,注释会欺骗阅读者,本人被骗过,也骗过别人。
注释只是一种代码的补充,如果方法,类,变量命名好的话,一般不需要注释,它并不能美化代码,丑陋的代码经过N次CR之后,除了开发者无人能懂,注释就变成了毒药。
一般下列注释还是可以的:
法律信息:只要有可能,就指向一份标准许可或其他外部文档,而不是把所有条款放到注释中
提供信息的注释:比如某个抽象方法的返回值,某个map参数中的键值
对意图的解释:就是为什么要这么做,对下面的代码带来了什么样的影响
阐释:把某种难明的参数或返回值,翻译为可读的形式
警示的注释
公共的API,这个我觉得一定要有。
相关文章推荐
- 题目:三数之和
- 题目:N皇后问题 II
- 很高兴加入写博客的行列,慢慢记录自己的一点点进步
- LeetCode ||Count Primes
- 微信抢红包源码
- 单例模式(Singleton)
- table表格css样式
- 随手记
- NBUT 1449 Annie (模拟)
- 202 Happy Number
- HDOJ5256 序列变换(dp)
- Python pip – error: invalid command ‘bdist_wheel’
- JQuery选择器操作
- 兄弟间的事,筹栎间的那点事
- Sublime Text 快捷键
- 摩天大厦不可伸缩
- [IOS]CoreAnimation基础[翻译6部分]
- git——OS X创建仓库以及链接github
- java中volatile关键字的含义
- 面试题:冒泡排序,选择排序,插入排序,快速排序,归并排序,堆排序