《代码整洁之道 程序员的职业素养》的读书笔记和文摘

7 min read

读书笔记:

《代码整洁之道 程序员的职业素养》一书主要讲述了如何写出易于阅读、易于维护、高效可靠的代码。作者通过对程序员的日常工作中常见的问题、误区进行剖析,总结出了一些实用的编码原则和规范。本书主要包括以下内容:

  1. 编码的基本原则

编写自解释性的代码、避免重复代码、保持代码简洁易懂、注重测试和文档等方面的原则。

  1. 命名规范

遵守一定的命名规范可以让代码更加易读、易理解、易维护,本章介绍了命名变量、函数、类、模块和包的规范,同时也注意到了一些常见的命名问题。

  1. 函数

良好的函数设计可以使代码更加清晰易读、易维护。本章介绍了一些函数设计原则,如单一职责原则、函数参数的设计、异常处理等。

  1. 注释

注释是代码中重要的一部分,不仅能够记录代码的设计思路和实现方法,还可以帮助他人理解代码、排查代码的问题。本章讲述了如何编写有用且易于理解的注释,并介绍了一些注释的常见问题。

  1. 类的设计

类的设计是面向对象编程中非常重要的一个方面,良好的类的设计可以使代码更加清晰易懂、易扩展和易维护。本章讲述了一些类的设计原则,如单一职责原则、开放封闭原则等。

  1. 系统设计

系统设计是一个综合性的工作,需要考虑众多因素,如功能需求、性能、可扩展性、可靠性、安全性等。本章介绍了一些系统设计方面的问题和原则,如模块化设计、API设计等。

  1. 测试

测试是保证代码质量的重要手段,本章介绍了一些测试的基本原则和技巧,如测试的覆盖率、测试的自动化等。

文摘:

  1. “代码就像诗歌一样,和语言有关。一个好的代码应该是能够讲述故事的,从中也应该可以得到启示。”

  2. “简洁的代码,是阅读者更容易明白的代码。”

  3. “零散的代码和注释比没有注释的代码更糟糕。”

  4. “一个好的命名是信息的载体,可以告诉开发者这个变量、函数、类、模块或包的用途。”

  5. “函数应该将输入转化为输出,不应该造成任何可见的副作用,也不应该改变不在自己作用域内的代码。”

  6. “面对一个复杂的问题,最好的解决方法通常是将问题分割成更小的可管理的部分。”

  7. “在系统设计中,模块的设计是至关重要的。一个好的模块应该是独立的、可重用的、可扩展的、可理解的。”

  8. “测试是保证代码质量的最好手段,从测试中也可以了解代码的实现细节和逻辑。”