毕设全是编程。最开始编了一个有一千多行的Main函数,处理Word文档里的数学公式。里面还用了不少goto语句。功能虽然实现了,心里面感到很可耻。改用面向对象的组织结构编,划分了一些类,每个类明显简洁了不少。
为了解决goto,又把递归玩得越来越溜了。终于2300多行的代码变成了不到900行。
在这个过程中,越发觉得,编写好代码,把代码编的像一首诗而不是一坨屎,简直是一种享受。我修改代码的过程中,发现了几本书非常好。比如《凌波微步 开发案例集》还有我手头的这本《代码整洁之道》。
做个读书笔记吧。
-
函数名应该传递信息,读你代码的人也是程序员,所以尽量使用可查找、CS专业的词语,其次才是领域专有名词。不要怕长名称。千万不要用一些不明所以,自作聪明的函数名,变量名。
-
类名要是名词,简短为好。
-
函数尽量短小,多少算短小呢——20行封顶。
-
一个函数只做一件事情,做好这件事情。如何辨别是否函数是做了一件事情呢,看这个函数是否还能再拆出一个函数。
-
每个函数中的语句应该保证在同一个抽象的层级上。用“自顶向下”的模式编程。如“要想怎样1,就要怎样2,要想怎样2,就要怎样3……”
-
函数的参数越少越好,0参比1参好,2参勉强接受,再多就不好了。如果函数看来需要两个、三个或三个以上的参数,就说明其中一些参数应该封装为类了
-
函数名与参数间最好应该形成一种良好的“动词/名词对应”,例如write(name).
-
抽离Try...Catch块,因为错误处理本身就是一件事,
-
由于函数足够小,故break,return,continue均可以出现
-
有一点一定要注意,没人能做到一开始就写出这样的程序
-
永远不要忘记,真正的目标在于讲好系统的故事
-
记住,所有的注释都是迫不得已
好的注释有:
1.法律信息
2.提供信息的注释
3.对意图的解释
4.阐释
5.警示信息
6.ToDo注释
坏注释有:
1.喃喃自语
2.多余的注释(无意义)
3.误导性注释
4.循规式注释
5.日志式注释
6.位置标记
如//Actions//////////////////////////
7.括号后的注释
如{
}//while
8.署名
9.注释掉的代码
10.非本地信息
11.信息过多 -
代码整洁关乎沟通,而沟通是专业开发者的头等大事
-
实体变量应该在类的顶部声明
代码在垂直位置上的区隔、靠近、引用与函数的毗邻 -
数据抽象
我们不愿意把暴露数据的细节,更愿意以抽象的形态表述数据。这并非使用借口/赋值器就可以万事大吉的
面向过程式代码难以添加新的函数,因为必须修改所有类 -
德墨忒尔定律
类C的方法f只能调用以下对象的方法
C
由f创建的对象
作为参数传给f的对象
由C的实体变量持有的对象
数据结构类的形式
1.数据传递对象
{
public a;
public b;
}
2."bean"结构
{
private a;
private b;
public class get{}
.......
}
网友评论