保持你的代码整洁的最佳方法

2025/05/06

纪律是一套标准、规则、试探法、原则和实践等。下面我来定义一些保持你的代码整洁的最佳方法:

  • 童子军规则。离开营地时先打扫干净。每次编写代码时,我们应该稍微清理一下旧代码,是否是别人编写的都没关系。整理一下就可以做出一点贡献。只是不要疯狂清洗一大堆东西,否则你可能会破坏某些内容。
  • 一定要非常简洁。记住,不要过度设计;不要用牛刀杀鸡。
  • YAGNI(你并不需要它)。不要因为将来可能添加更多功能就写一个工厂设计模式。等到需要的时候再创建工厂,不要提前行事。
  • 最小意外原则。为每件事物找到一个地方,然后将其放置在其他开发人员更容易找到的地方。尽量不要放在会让别人感到意外的去处。
  • “如果没有测试,那就默认它坏了”。编写大量测试,尤其是单元测试,否则你会后悔的。
  • 类和函数应该尽量小一些,并遵守单一责任原则(SRP)。函数不应超过 4 行,而类不应超过 100 行代码。是的你没看错。它们也应该只做一件事。
  • 函数应该没有副作用。副作用(例如修改输入参数)是有害的。确保你的代码中没有副作用。尽可能在函数合约中明确这一点(例如,传递原生类型或没有 setter 的对象)。
  • 避免重复。抽象出常见的事物并将它们放在一个位置,从而避免重复的代码。

Post Directory