每个程序员都应该了解这些约定和实践。

如果没有规则和标准，我们将生活在彻底的混乱之中；如果每个程序员都可以自由地编写任何他想写的代码，我们可能仍然处于计算机可以占据整个公寓的时代😁。

但幸运的是，事实并非如此😌。每个程序员都应该了解一些规则和标准。如果你之前不了解这些标准，别担心，我以前也是个糟糕的程序员，非常糟糕，但现在我进步了很多，而且还在不断提高。如果你已经了解这些标准，我恭喜你。不过，为了安心起见，还是请你读到最后。

我不会详细解释或举例说明这些规则，因为每条规则都需要至少一整篇文章来阐述，其中包含大量实际案例、例外情况或特殊情况。我只会列出这些规则，并在每篇文章中单独介绍。

1. 注重代码质量，
   这意味着你要编写可读性强的代码。使用与你的编程语言或技术相关的代码风格规则，并保持一致（例如，Python 的代码风格规范在 PEP 8 文档中有详细描述）。你可以在 IDE 中安装与你的编程语言/技术相关的代码检查扩展。它能帮助你提升代码质量，并养成良好的代码习惯。

2. 给
   变量、函数、类和包起有意义的名字。这有助于你理解代码库的整体结构，而无需阅读实现细节。

3. 遵循 DRY（不要重复自己）原则，
   尽可能避免重复编写代码。这首先可以减少代码库的大小，而且如果出于任何原因需要修改或改进代码，您只需修改一次，而无需在多个地方重复相同的更改。

4. 编写处理特定任务的简短函数。
   尽量保持函数简短，并确保每个函数只处理一个任务。此外，这有助于代码重用和代码重构。

5. 完善代码文档。
   尽可能为函数、类和包添加有用的注释和文档。为函数参数和返回值添加描述和类型提示。但要避免使用显而易见的注释。这也有助于在不阅读实现细节的情况下理解代码库的整体结构。如果文档完善，一些 IDE 扩展甚至可以帮助你自动生成软件文档。

6. 避免在代码中使用魔法数字或硬编码值，
   这不仅能挽救你的生命，还能提高代码库的可维护性。

7. 将代码行长度限制为标准值（例如 80 个字符），
   这样也能提高代码的可读性。

非常重要

• 测试你的代码。尽可能多地编写测试用例（至少是单元测试），尤其是在功能比较棘手或复杂的时候。
• 要放眼全局。重视可扩展性和性能问题。即使只是个业余项目，也不要像只有自己一个人在使用网站那样编写代码；也不要像只有十个或一百个用户那样编写软件，要放眼全局。想想如果用户数量达到数百万甚至数十亿会发生什么。数据库请求或循环会不会耗时过长？这段代码还能正常运行吗？在编写代码时要不断思考这些问题，并持续改进代码。
• 重视代码审查。在代码审查过程中，你不仅能学到很多东西，还能与他人分享经验。最重要的是，审查能让你及早发现 bug，从而有助于缩短技术部门的工期。所以，务必认真对待代码审查。
• 避免在代码中使用“hack”式方法。不要随意修改代码，寻找临时的快速解决方案来绕过问题或漏洞。这些方法很可能在以后再次失效（甚至可能在生产环境中失效）。相反，应该深入研究代码源头，花时间理解问题，并努力找到彻底有效的最终解决方案。如果你是通过 Stack Overflow 等网站上的帮助找到的，请确保在将其添加到你的代码库之前完全理解它。

本文到此结束。如果您有任何遗漏的精彩见解，请在评论区留言。我可能会在另一篇文章中提及。

我分享我所知道的，因为：

我学得越多，就越意识到自己知道的还很少。（爱因斯坦）