代码整洁之道(RobertC.Martin)之第四章: 注释

一十四画生

于 2021-04-27 19:43:25 发布

阅读量218

点赞数

分类专栏：代码整洁之道文章标签：代码规范

本文链接：https://blog.csdn.net/weixin_44395929/article/details/116208085

版权

6 篇文章 1 订阅

订阅专栏

本章内容主要为注释规范, 对于内容有删除, 去除了一些不符合我们国情的条例。

注释不如美化 => 其实这也是作者想表达的, 用再多的注释不如一个方法名来的直接
注释不如用代码阐释 => 作者对注释其实很反感
好注释 => 作者又一次声明了最好的注释就是不写注释
警示 => 对于一些测试用例解释(我觉得注释用来警示是个很好的习惯,因为写太多注释我们会反感, 不写可能又会损失部分性能, 所以我一般写注释也只是用来警示)
todo注释 => 要做什么却未做和警示类似
公共api => 前端写公共组件必要注释, 已经吃过很多亏了
喃喃自语 => 注释要么不写, 要么就写到自己感觉最贴切。不要喃喃自语,只让自己一个人听见
多余注释 => 你仅仅对一个请求接口封装了一下, 你还费一大串话去描述??
误导性注释 => 不要写带有误导性数据, 你要返回的是个对象, 你注释写着返回你要的数字
循规式注释 => 要求每个变量或方法有注释(我个人觉得不合理)
日志式注释 => (讲真,国内的代码要求循规蹈矩的注释, 固然有各种层次不齐的水平的人在协作的原因, 也有部分leader想偷懒的心在里面。曾见过一个奇葩的要求: 每个文件头部都要写明编辑者是谁, 什么时间, 哪个模块等等, 甚至要求每个方法函数变量都要加上注释。)
废话注释 => 我们不想看的注释都是废话注释, 以上规范都可以这么理解
可怕的废话注释 =>

　	/** The name. */
　　private String name;
　　/** The version. */
　　private String version;
　　/** The licenceName. */
　　private String licenceName;

以上规范和之前所写的, 在某种意义上是有一样的, 但是我想作者把这些能拉出来单独列出来, 还是因为我们这群代码猴子写的代码不堪入目吧。

关注