注释的反面教材
来源:互联网 发布:spss输入数据是问号 编辑:程序博客网 时间:2024/06/11 17:45
都说好注释应该写Why而不是How,这里给个只写How的废话注释作为反面教材。
http://blog.csdn.net/zoomdy/article/details/71698683
mingdu.zheng at gmail dot com
void SpiritRadioSetModulation(ModulationSelect xModulation){ uint8_t tempRegValue; /* Check the parameters */ s_assert_param(IS_MODULATION_SELECTED(xModulation)); /* Reads the modulation register */ SpiritSpiReadRegisters(MOD0_BASE, 1, &tempRegValue); /* Mask the other fields and set the modulation type */ tempRegValue &=0x8F; tempRegValue |= xModulation; /* Writes the modulation register */ g_xStatus = SpiritSpiWriteRegisters(MOD0_BASE, 1, &tempRegValue);}
上面这段代码里的注释是不是都是废话呢。典型的为了写注释而写注释,代码本身的可读性已经非常强了,看代码本省就足够理解代码了,何必再写多余的注释?4行注释都是How型注释。所谓How型注释是解释代码是怎么工作的,Why型注释是解释代码为什么要这么写。How型的注释是完全没有必要的。可读性强的代码,阅读代码本省就可以理解代码是怎么工作的,写注释去解释可读性差的代码还不如想想怎么改进代码的可读性呢。优秀的代码应该是自注释的(Self-Documenting Code),就是说代码自己能把自己解释清楚,不用注释来瞎搀和。
- 《避免代码注释的五大理由》
- 《五种应该避免的代码注释》
0 0
- 注释的反面教材
- Vue v-for 的反面教材。
- 影响项目代码可读性的反面教材
- 反面教材:五步走让你的网站迟钝不堪
- 公务员就业歧视是一部 权威 的反面教材
- 墜落SOHO宅----一個自由職業者的反面教材
- 要离职了把这个项目的总结贴出来,是不是反面教材(⊙o⊙)?
- 判断三角形(反面教材)
- iOS开发里不用MVC反面教材
- <!-- -->注释和<%-- --%>注释的区别
- 注释的重要性以及注释的格式
- PhpStorm 头部注释、类注释和函数注释的设置
- PhpStorm 头部注释、类注释和函数注释的设置
- jsp注释和Java注释的总结;
- 批量 // 注释替换为 /*的注释
- JSP注释和HTML注释的区别
- PHP注释以及各种语言的注释
- PHP注释及各种语言的注释
- ElasticsearchCRUD使用(六)【EF和Elasticsearch的MVC应用程序】
- React Native导航器之react-navigation使用
- caffe 添加YOLO新层Leaky Layer
- Hadoop学习之一
- 学习小结
- 注释的反面教材
- 0511
- Leetcode-Longest Substring Without Repeating Characters
- Android 获取本地外网IP、内网IP、计算机名等信息
- mysql拷贝表的几种方式
- Anaconda自定义配置以及远程登录jupyter
- 第一天练习练习博客怎么用
- linux权限与chmod命令
- 字符串转换为数字