代码整洁之道读书笔记----第四章---注释--第二节-坏孩子与坏注释

天下间的父母都会认为自己的孩子是好孩子，但是事实…

什么样的注释是坏注释，什么样的注释是我们需要尽力避免的？
自己对程序的喃喃自语==废话+误导
如果要写注释，那就写切题的，就要写好的，不要随意的去写，因为注释是大家看的，不是你自己一个看的。只有你自己才能看懂你自己的喃喃自语，或许日子久了，你自己也看不懂了，更别提大家了。

废话型注释
非常明显的东西，你还要加一堆注释，比如这是一个if语句，这抛出一个什么类型的异常，

/**The name.**/
private String name;/**The version.**/
private String version;/**The day of the month.**/
private int dayOfMonth;

多余的注释，误导性的注释

程序猿有时候在码代码的时候，会出现老注释的情况，就是方法的实现意图已经修改了，而注释却没有修改，结果就造成了，在阅读代码注释的时候发现代码和注释驴头不对马嘴。更严重的就是当老代码的注释和新代码还有那么一点点关联的时候，造成的误导，会让读代码的人原地爆炸。

日志型的注释
在进行代码修改的时候，把每次的修改意图，修改的东西全部当成注释写在类和方法的注释中。
我的天，要这种东西干嘛？让gitHub做呀，你是不是看不起我gitHub？

位置标记

// Actions /

别做这个位置标记的，多余~

注释代码
Excuse me ?
对于无用的代码，删掉删掉删掉（重要的事情说三遍）
对于过时的方法，别直接删别直接删别直接删（重要的事情说三遍@Deprecation）

今天就到这里了，明天再见。

代码整洁之道读书笔记----第四章---注释--第二节-坏孩子与坏注释相关推荐

代码整洁之道精华——第十四章逐步改进
阅读本文有两种原因:第一,你是个程序员:第二,你想成为更好的程序员.你如果想成为更好的程序员,那就请细细品味文章内容,它绝不会让你失望. 代码整洁之道教给大家如何编写整洁的代码,而不仅仅是能运行的代码 ...
代码整洁之道-读书笔记1
第一章整洁代码 1.2糟糕的代码糟糕的代码会毁掉一个公司,但是为什么会出现糟糕的代码? 可能是因为赶时间,如果花时间重构或者清理以前的代码,老板就会大发雷霆. 勒布朗法则:稍后等于用不. 1.3混 ...
代码整洁之道读书笔记——第一章：整洁代码
软件质量,不仅仅依赖于项目架构和项目管理,同样重要的是代码质量!!! 序神在细节之中,其实干什么事都一样,从小到大,一直明白一个道理:细节决定成败! 软件架构在开发中占据重要地位.其次,宏达建筑的最 ...
代码整洁之道-读书笔记之整洁的代码
1.整洁代码阅读本书有两个原因,第一,你是个程序员,第二,你想成为更好的程序员 1.1 要有代码有人认为随着时代的发展,写代码不再是问题,我们更应该关注建模和需求这句话后半句没有问题,因为语言在 ...
代码整洁之道读书笔记（Ch4-Ch7）
这几章从注释.程序格式.对象与数据结构的规范以及错误处理四个方面介绍了如何使代码变得简洁易懂.不同于上次摘抄的方法,这一次我会结合第一次个人作业的代码进行分析. 第四章注释这一章告诉我们,好的注 ...
代码整洁之道读书笔记
第1章整洁代码 1.1 要有代码 1.2 糟糕的代码稍后等于永不 1.3 混乱的代价假设前期不注意.后期的加入代码.改动效率都很低 1.3.1 华丽新设计 1.3.2 态度 1.3.3 ...
代码整洁之道----读书笔记
一.有意义的命名规则二.优雅的函数三.良好的注释四.整齐的格式转载于:https://www.cnblogs.com/k5bg/p/11063235.html
《Linux内核设计与实现》第八周读书笔记第四章进程调度
20135307 张嘉琪第八周读书笔记第四章进程调度调度程序负责决定将哪个进程投入运行,何时运行以及运行多长时间,进程调度程序可看做在可运行态进程之间分配有限的处理器时间资源的内核子系统.只有 ...
【苦练基本功】代码整洁之道 pt1（第1章-第3章）
代码整洁之道 pt1(第1章-第3章) 1 整洁代码 1.1 要有代码 1.2 糟糕的代码 1.3 混乱的代价 1.3.1 什么是整洁代码? 2 有意义的命名 2.1 名副其实 2.2 避免误导 2. ...
【苦练基本功】代码整洁之道 pt4（第10章-第12章）
代码整洁之道 pt4(第10章-第12章) 10 类 10.1 类的组织 10.2 类应该短小 10.2.1 单一权责原则 10.2.2 内聚 10.2.3 保持内聚性就会得到许多短小的类 10.3 ...

代码整洁之道读书笔记----第四章---注释--第二节-坏孩子与坏注释

代码整洁之道读书笔记----第四章---注释--第二节-坏孩子与坏注释相关推荐

最新文章

热门文章