具体描述
《易读代码的艺术(影印版)》分析了许多的“糟糕代码”(这些代码有很多是出自于他们自己之手),他们试图厘清为什么这些代码如此糟糕以及如何改进这些代码。他们得出的结论是:你必须写出让他人(这里也包括你自己)花费最少时间能够理解的代码。
作者简介
博斯韦尔(Dustin Boswell),毕业于加州理工学院,在谷歌公司从事过五年的Web信息采集基础设施和广告营销计划的研究工作。他先后构建过多个Web站点,目前的主要研究兴趣在于大数据的处理和机器学习领域的相关技术。
富彻(Trevor Foucher),过去十年中先后在微软公司担任Windows及安全相关产品的工程师、经理和技术领导者的职务,现任职于谷歌公司,主要从事谷歌广告营销计划和搜索基础设施的研究工作。
目录信息
1 CODE SHOULD BE EASY TO UNDERSTAND
What Makes Code "Better"?
The Fundamental Theorem of Readability
Is Smaller Always Better?
Does Time—Till—Understanding Conflict with Other Goals?
The Hard Part
Part One SURFACE—LEVEL IMPROVEMENTS
2 PACKING INFORMATION INTO NAMES
Choose Specific Words
Auoid Generic Names Like Imp and retual
Prefer Concrete Names ouer Abstract Names
Attaching Extra Information to a Name
How Lon.g Should a Name Be?
Use Name Formatting to Conuey Meaning
Summary
3 NAMES THAT CAN'T BE MISCONSTRUED
Example: Filter()
Example: Clip(text, length)
Prefer rain and max for (Inclusiue) Limits
Prefer first and last for Inelusiue Ranges
Prefer herin and end for.Inclusiue/Exclusiue Ranges
Naming Booleans
Matching Expectations of Users
Example: Eualuating Multiple Name Candidates
Summary
4 AESTHETICS
Why Do Aesthetics Matter?
BearranRe Line Breaks to Be Consistent and Compact
Use Methods to Clean Up Irregularity
Use Column Alignment When Helpful
Pick a Meaningful Order, and Use It Consistently
Organize Declarations into Blocks
Break Code into "Parafgraphs"
Personal Style uersus Consistency
Summary
5 KNOWING WHAT TO COMMENT
What NOT to Comment
Becording Your Thouyhts
Put Yourself in the Reader's Shoes
Final Thoughts——Getting Over Writer's Block
Summary
6 MAKING COMMENTS PRECISE AND COMPACT
Keep Comments Compact
Avoid Ambiguous Pronouns
Polish Sloppy Sentences
Describe Function Behavior Precisely
Use Input/Output Examples That Illustrate Corner Cases
State the Intent of Your Code
"Named Function Parameter" Comments
Use Information—Dense Words
Summary
Part Two SIMPLIFYING LOOPS AND LOGIC
7 MAKING CONTROL FLOW EASY TO READ
The Order of Arguments in Conditionals
The Order of if/else Blocks
The ?: Conditional Expression (a.k.a."Ternary Operator")
Avoid dogwhile Loops
Returning Early from a Function
The Infamous goto
Minimize Nesting
Can You Follow the Flow of Execution?
Summary
8 BREAKING DOWN GIANT EXPRESSIONS
Explaining Variables
Summary Variables
Using De Morgan's Laws
Abusing Short—Circuit Logic
Example: Wrestling with Complicated Logic
Breaking Down Giant Statements
Another Creative Way to Simplify Expressions
Summary
9 VARIABLES AND READABILITY
Eliminatinfg Variables
Shrink the Scope of Your Variables
Prefer Write—Once Variables
A Final Example
Summary
Part Three REORGANIZING YOUR CODE
10 EXTRACTING UNRELATED SUBPROBLEMS
Introductory Example: find Closest Loeation()
Pure Utility Code
Other General—Purpose Code
Create a Lot of General—Purpose Code
Project—Specific Functionality
Simplilying an Existing Interface
Reshaping an Interface to Your Needs
Taking Things Too Far
Summary
11 ONETASK ATA TIME
Tasks Can Be Small
Extracting Values from an Object
A Larger Example
Summary
12 TURNING THOUGHTS INTO CODE
Describing Logic Clearly
Knowing Your Libraries Helps
Applying This Method to Larger Problems
Summary
13 WRITING LESS CODE
Don't Bother Implementing That Feature——You Won't Need It
Question and Break Douan Your Requirements
Keeping Your Codebase Small
Be Familiar with the Libraries Around You
Example: Using Unix Tools Instead of Coding
Summary
Part Four SELECTED TOPICS
14 TESTING AND READABILITY
Make Tests Easy to Read and Maintain
What's Wrong with This Test?
Making This Test More Readable
Making Error Messages Readable
Choosing Good Test Inputs
Naming Test Functions
What Was Wrong with That Test?
Test—Friendly Deuelopment
Going Too Far
Summary
15 DESIGNING AND IMPLEMENTING A "MINUTE/HOUR COUNTER"
The Problem
Defining the Class Interface
Attempt 1: A Naiue Solution
Attempt 2: Conueyor Belt Design
Attempt 3: A Time—Bucketed Design
Comparing the Three Solutions
Summary
A FURTHER READING
INDEX
· · · · · · (收起)
读后感
细节决定成败,思路清晰、言简意赅的代码让程序员一目了然;而格式凌乱、拖沓冗长的代码让程序员一头雾水。除了可以正确运行以外,优秀的代码必须具备良好的可读性,编写的代码要使其他人能在最短的时间内理解才行。本书旨在强调代码对人的友好性和可读性。 本书关注编码的细节...
接着去年11月份实习时用 kindle 读到 20% 落下的好书,中间隔了几个月... 这本新书的名字也是“The Art of xxx”,很容易让我感觉到这是很严谨不易读的书,那本 TAOCP 是我这种数学能力超弱的人读不了的,而 TAOUP 对几乎没怎么用过 Unix/Linux 的我也比较难理解甚至不知所云...
很短的一本小书,基本是在编译代码的时候顺便看完的,差不多花了三天的时间吧,看完的整体感受是很实用,增加了对整理代码可读性的欲望。可以说是软实力的提升吧,书里面举的例子都很实用,基本上实战都可以用到,我觉得这本书应该至少阅读两遍吧。 除了这本书以外,还可以考虑...
之前做重构项目的时候,就发现了代码质量的问题,一些老模块的代码写的简直令人发指,没有文档没有任何资料的情况下,只能人肉去读代码梳理功能,经历了各种痛苦,后来也不断在组内各种灌输代码质量的意识,在这方面做了一些推动。 偶然间翻了这本书,感觉一下找到了知己,命名...
之前做重构项目的时候,就发现了代码质量的问题,一些老模块的代码写的简直令人发指,没有文档没有任何资料的情况下,只能人肉去读代码梳理功能,经历了各种痛苦,后来也不断在组内各种灌输代码质量的意识,在这方面做了一些推动。 偶然间翻了这本书,感觉一下找到了知己,命名...
用户评价
我一直认为,写代码是一种非常孤独的活动,大部分时间都是一个人对着屏幕敲敲打打。《易读代码的艺术》这本书,却让我看到了代码世界的另一番景象。它让我明白,代码并非孤立的存在,而是承载着团队协作和知识传承的载体。书中关于如何编写清晰、简洁、易于理解的代码的论述,让我耳目一新。它并没有给我提供一堆生硬的规则,而是通过大量的实际案例,展示了“好的代码”是如何诞生的,以及它们在实际项目中带来的巨大好处。我特别欣赏书中关于“代码评审”的讨论,让我意识到了团队协作在保证代码质量方面的重要性。读完这本书,我感觉自己不再是孤军奋战,而是开始体会到代码世界的社群文化,以及如何通过编写易读的代码,为这个社群做出贡献。
这本书简直就像一股清流,瞬间洗刷了我以往对编程书籍的刻板印象。我一直觉得写代码就像是跟机器打交道,追求的是冰冷的逻辑和效率,但《易读代码的艺术》却告诉我,代码同样可以充满人情味,可以像优美的散文一样令人赏心悦目。这本书并没有直接给我一大堆晦涩的语法规则或者复杂的算法,而是从一个非常宏观的视角,阐述了“易读”的重要性。它让我意识到,写代码不仅仅是让程序能够运行,更重要的是让其他开发者(包括未来的自己)能够轻松地理解它。书里举了很多生动的例子,对比了“难读”代码和“易读”代码在实际开发中的区别,这种对比非常有冲击力,让我深刻体会到清晰代码带来的巨大效益,比如减少bug,加快迭代速度,降低维护成本等等。它不仅仅是教我“怎么写”,更是让我思考“为什么这么写”,这种对根本问题的探讨,比单纯的技术手册更有深度。读完这本书,我感觉自己对编写代码的理解上升到了一个新的层次,不再仅仅是码农,而是开始体会到“匠人”精神在代码世界里的体现。
在我看来,编程领域充斥着各种各样关于“快”的讨论:快速开发、快速迭代、高性能等等,但《易读代码的艺术》却将目光投向了“慢”——慢下来,去思考如何让代码更容易被理解。这本书的独特之处在于,它并没有直接教我如何写出“最高效”的代码,而是从一个“人性化”的角度出发,强调了代码的可读性和可维护性。它让我明白,那些看似“慢”的投入,在长期来看,却能带来惊人的“快”——更少的bug,更低的维护成本,更顺畅的团队协作。书中对于各种“坏味道”代码的剖析,以及如何将其转化为“好味道”的建议,都非常实用。它并没有给我空洞的理论,而是通过大量的实践指导,让我能够立刻将学到的知识运用到实际开发中,并从中体会到乐趣。这本书让我对“代码质量”有了全新的认识,不再仅仅是停留在功能的实现上,而是将其提升到了一个更高的维度。
我曾经在接手一个老项目时,被那堆令人发指的代码吓得瑟瑟发抖,那种感觉就像闯入了一个迷宫,每个角落都充满了未知的陷阱。那时我就在想,有没有什么办法能让代码不至于如此难以理解?《易读代码的艺术》的出现,简直就是为我量身定做的。这本书并没有直接给我一堆“银弹”式的解决方案,而是通过一系列巧妙的隐喻和类比,让我逐渐领悟到“易读”的本质。它就像一个经验丰富的导师,循循善诱地引导我思考代码的可读性,而不是强制我遵循某些死板的规范。书中关于命名、注释、代码结构等方面的讨论,都非常有启发性。我特别喜欢它关于“代码即文档”的理念,让我意识到,好的代码本身就应该能够清晰地表达其意图,无需过多的额外解释。这本书让我不再把编写代码看作是一件枯燥乏味的体力活,而是将其视为一种沟通和表达的方式,这大大提升了我编写代码的积极性和成就感。
说实话,我一开始对“易读代码”这个概念并没有太深刻的体会,总觉得只要功能实现就好,至于代码写得是否“好看”,似乎并不是那么重要。《易读代码的艺术》这本书,却用一种非常独特的方式,颠覆了我的认知。它并没有直接给我提供一套“万能公式”来编写易读代码,而是通过一个个深入浅出的故事和案例,让我逐渐理解了“易读”的价值所在。它让我意识到,代码的易读性不仅仅是为了取悦他人,更是为了提高整个开发团队的效率,减少不必要的沟通成本,甚至能够影响到项目的长期健康发展。这本书的语言非常生动有趣,读起来丝毫没有枯燥乏味的感觉,仿佛在听一位经验丰富的开发者分享他的心得体会。它并没有给我灌输什么高深的理论,而是教会我如何从一个更广阔的视角去看待代码,去思考代码的生命周期,以及它对后续开发者的影响。
思路清晰,言简意赅
a great book that answers my question of what is good code.
读第二遍了,其中的写出易读代码的原则,仍然觉得非常受用。以后也应当会常常参考的。
初级程序员必读
思路清晰,言简意赅