《编写可读代码的艺术》读书笔记(上)表面层次的改进

最近在看《编写可读代码的艺术》,在这里记录一下点点滴滴

代码应当易于理解##

可读性基本定律:代码的写法应当使被人理解它所需的时间最小化,但并不是越小越好,要注意理解代码所需的时间是否与其他目标有冲突

第一部分:表面层次的改进###

  • 选择好的名字
  • 写好的注释
  • 把代码整洁的写成更好的格式
选择好的名字(名称语义化)
  • 选择专业的词 (不使用Get,使用Fetch或者Download等更专业的词)
  • 避免泛泛的名字(例如temp)
  • 用具体的名字代替抽象的名字
  • 使用前缀或后缀来给名字附带更多信息
  • 决定名字的长度(小的作用域使用短的名字,丢掉没有用的词ConvertToString简介为ToString)
  • 利用名字的格式来表达含义(例如大写代表常量min和max等)
代码整洁的写成更好的格式(提高审美)
  • 使用一致的布局,让读者很快就习惯这种风格
  • 让相似的代码看上去相似
  • 把相关的代码行分组,形成代码块

提高代码审美的技巧

  • 重新安排换行来保持一致和紧凑
  • 用方法来整理不规则的东西
  • 在需要时使用列对齐
  • 选一个有意义的顺序始终一致的使用它
  • 把声明按块组织起来(比如方法和变量声明应该自成一块)
  • 个人风格的一致性(一致的风格比“正确”的风格更重要)
该写什么样的注释(注释物有所值)
  • 不要为了注释而注释
  • 不要给不好的名字加注释(先把名字改好)
  • 记录你的思想
    • 加入导演评论(自己的见解)
    • 为代码中的瑕疵写注释(同时可以写一些要做的事)
    • 给常量加注释
  • 站在读者角度
  • 公布可能的陷阱
  • 全局观注释(团队的新成员快速熟悉代码)
  • 总结性注释
  • 克服作者心理阻滞
写出言简意赅的注释(注释应当有很高的信息)
  • 让注释保持紧凑
  • 避免使用不明确的代词
  • 润色粗糙的句子
  • 精确的描述函数(方法)的行为
  • 声明代码的意图
  • 采用信息含量高的词
最后编辑于 :
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 前言:人生有很多第一次,作为一只不谙世事的小程序媛,第一次踏出校门,开始实习,感触良多,其中,颇为震撼的一点是,原...
    sunnyaxin阅读 1,153评论 3赞 4
  • 0. 前言 程序员给人的印象大多都是蓬头垢面,衣着随意。然而,我认为一个优秀的程序员对于代码一定有他的审美。如果你...
    书呆子的复仇阅读 683评论 0赞 0
  • 以下是书里文字的引用与整理 前言 可读性基本定理:代码的写法应当使别人理解它所需的时间最小化。 一、表面层次的改进...
    消失3003阅读 1,862评论 0赞 5
  • 一副皮囊,斗不过日月 一腔热血,耐不过经年 岁年长,恍恍惚惚 已是二八年纪 却未有劳心之去处 梦犹在,真真切切 非...
    天光_娜娜阅读 131评论 0赞 0
  • 一太太,偶然间获得一花瓶,对此,甚是欢喜,便每日都要细细欣赏与把玩,日复一日,年复一年,对花瓶的喜爱却分毫...
    度_e885阅读 400评论 0赞 0

友情链接更多精彩内容