C#代码整洁之道:代码重构与性能提升
上QQ阅读APP看书,第一时间看更新

第1章 C#的编码标准和原则

C#的编码标准和原则的主要目的是提高程序员的编码能力,即编写更加高效、更易维护的代码。在本章中,我们将对比良好代码和劣质代码的范例,从而说明制定编码标准、原则和方法的必要性。之后我们还会讨论命名、注释和格式化代码(包括类、方法和变量)的规则。

冗长的程序是难以理解和维护的。对于初级程序员,理解这样的代码及其功能的过程令人望而生畏;团队也难以在这种项目上顺畅地合作;而从测试的角度而言,这会使事情变得更加困难。因此,我们会讨论如何用模块化的方法将程序分割为更小的模块。这些模块一同工作来生成一个功能完整的解决方案。这种解决方案不仅可以进行完全的测试,多个团队可以同时开发,而且更加易于阅读、理解和记录。

本章的末尾将介绍一些编程设计规范。它们是:KISS、YAGNI、DRY、SOLID和奥卡姆剃刀法则。

本章涵盖如下主题:

  • 编码标准、原则和方法的必要性
  • 命名规则和方法
  • 注释和格式化
  • 模块化
  • KISS
  • YAGNI
  • DRY
  • SOLID
  • 奥卡姆剃刀法则

学习目标:

  • 理解为何质量低劣的代码会给项目带来负面影响。
  • 理解良好的代码是如何为项目带来积极的影响的。
  • 理解编码标准如何改善代码,以及如何实施。
  • 理解编码原则如何提升软件质量。
  • 理解编码方法如何辅助我们编写整洁的代码。
  • 实现编码标准。
  • 选择假设最少的解决方案。
  • 减少重复代码,编写符合SOLID原则的代码。