clean-code 3

发布时间 2024-01-06 23:16:24作者: 会秃头的小白

本书的主要内容围绕着编写高质量、易读、易维护代码的方法和实践展开。以下是一些本书强调的主要内容:

命名

  • 命名应当具有描述性,准确地反映出变量、函数、类的功能和用途。
  • 避免使用含糊不清或者单个字母的变量名,应当选择具有意义的命名。

函数

  • 函数应当尽可能短小,单一责任原则是编写函数的核心准则。
  • 函数应当采用清晰的命名,清晰地表达其功能和意图。

注释

  • 注释应当用于解释代码的意图和目的,而不是重复代码本身。
  • 应当尽可能写出自解释的代码,减少对注释的依赖。

格式

  • 代码格式应当一致,遵循统一的风格和规范。
  • 适当的缩进、空格和换行能够提高代码的可读性。

错误处理

  • 错误处理应当清晰、一致,并且应当尽早地进行。
  • 避免使用魔法数字和硬编码,应当使用常量和枚举来提高代码的可维护性。

测试

  • 编写测试是编写高质量代码的关键一步,应当采用自动化测试来保证代码质量。
  • 测试应当覆盖代码的各个分支和边界条件,以确保代码的稳定性和可靠性。

重构

  • 重构是改善代码质量的有效手段,应当勇于重构旧有代码。
  • 通过不断地重构,可以不断地改进代码的可读性、可维护性和灵活性。