《编写可读代码的艺术》总结与分享

发布时间 2023-10-11 23:04:50作者: 笨喵敲代码

《编写可读代码的艺术》

本书是一本帮助代码写的更好的书,本人阅读时间为国庆一周,读完觉得这本书很有意思,因此准备做个总结,但是厌烦了很多书的总结,枯燥乏味且罗里吧嗦,把书的目录和章节列出来,并且每个部分讲点就结束,实在是即浪费自己的时间也浪费别人的时间,因此本人尽量用精简和核心的话,去重新理解这本书。我决定用新的方式去理解这本书,每个章节、知识点都先用一句话去概括。

本书目的

一句话概括:本书的最终目的是如何写出让别人容易理解的代码。
(你是否看到别人的代码一头雾水,各种稀奇古怪的拆分,各种乱糟糟的函数体,一个方法中几百行,不断涌现的成员变量,各种地方的判空,寥寥无几的注释,我们无法改变别人,但是可以改变自己避免成为这样的人。)

本书结构

一句话概括:从外表(变量名、注释、排版)到内在(更容易理解的逻辑和结构)

1. 外表(变量名,注释,排版)

一句话概括:

  • 变量名需要携带更多的信息,类型也好,功能也好,同时作用域越大,变量名也应该涵盖的信息越多。
  • 写出让读者理解代码的注释(类级别写全局观的注释,具体细节写怎么做,有坑的地方写很难处理)
  • 使用换行与列对齐将“相似的代码看起来很相似”,优化代码的顺序使其更美观,复杂的流水线步骤代码添加空行分割步骤

1.1 变量名

变量名