代码整洁之道(Clean Code) 笔记(二)
来源:互联网 发布:优易淘宝小号交易平台 编辑:程序博客网 时间:2024/06/17 20:30
第四章:注释
- 别给糟糕的代码加注释 -- 重新写吧
- 什么也不会比乱七八糟的注释更有本事搞乱一个模块。什么也不会比陈旧,提供错误信息的注释更有破坏性
- 若编程语方足够有表达力,或者我们长于用这些语方来表达意图,就不那么需要注释 -- 也许根本不需要
- 注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。注释总是一种失败
- 不准确的注释要比没注释坏得多。它们满口胡言。代码,只有代码能忠实的告诉你它做的事
- 好注释不多,如法律信息,警示等。我都不觉得
TODO
是多好的东西 - 大多数注释都是坏注释,甚至一些 IDE 自动生成的代码也加一堆的废话注释,分散阅读注意力。我也写过那种日志式注释,这本是版本控制系统干的事。
- 很奇怪 IntelliJ IDEA 还在自动为新建的类加下创建者,代码是团队共有,时间长了根本就与作者无半毛关系。我经常碰到这种写有作者的代码哭笑不得,直接把原作者改了或删了也不太好,还不如把文件删了,新建一个没有作者注释的类
- 直接把代码注释掉是种讨厌的做法,自己可能不会再启用,其他人以为很重要更不敢删。不用了最好果断删掉,版本控制系统会帮你记住历史。
- 个人认为,注释会胡说八道,产品代码和测试代码不会撒谎。有功夫写注释还不如写好测试用例,测试需要维护,它本身就是最真实的文档。
阅读全文 >>
0 0
- 代码整洁之道(Clean Code) 笔记(二)
- 《Clean Code》代码的整洁之道(二)
- Clean Code 《代码整洁之道》阅读笔记
- 代码整洁之道(Clean Code) 笔记(一)
- 代码整洁之道(Clean Code) 笔记(三)
- 代码整洁之道 clean code
- Clean Code 代码整洁之道 心得
- 代码整洁之道 clean code
- 代码整洁之道,clean code
- Clean Code 代码整洁之道
- Clean Code中译本《代码整洁之道》部分勘误提示
- 读代码整洁之道 clean code一些命名规则
- 《Clean Code》代码的整洁之道(一)
- 《Clean Code》代码的整洁之道----并发编程
- 《代码整洁之道》(《Clean Code》)读书笔记
- 【杂谈】Clean Code 代码整洁之道学习总结
- 代码整洁之道笔记(二)
- 代码整洁之道笔记(二)
- Java源码集合类TreeMap学习1——数据结构3二叉树创建代码
- JZOJ 5048. 【GDOI2017模拟一试4.11】IQ测试
- LearningNotes 变分自编码(VariationalAutoEncoder VAE)
- 文档对象模型DOM(获取元素节点、设置节点属性)
- 百练_2757字符串数组排序问题
- 代码整洁之道(Clean Code) 笔记(二)
- fl2440——内核自带LED的使用
- 没有任何公式——直观的理解变分自动编码器VAE
- LeetCode#66. Plus One
- mysql实验(一)
- Button按钮关于跳转页面问题
- 如果缺少一个库,如何知道yum该安装谁?
- CCFCSP201312-1出现次数最多的数
- linux常见上传下载,以及跨机器文件传输命令总结。