读《代码整洁之道》有感

毕设全是编程。最开始编了一个有一千多行的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{}
.......

}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容