什么是通用的“干净编码”约定？

Question

除了特定于语言的结构，对于使用 PHP、javascript、java 和 python 编程的人来说，前 10 名必须做的干净编码是什么？我想让我的代码尽可能干净和可读。例如，将函数体左括号与函数声明放在同一行与新行有什么关系？另外，例如 (x==10) 与 (x == 10) 之间的间距是什么？任何有关干净编码的有用提示将不胜感激！

Answer 1

这里有一些可能会有所帮助：

1. 为变量和方法提供直观的名称
2. 使用您特定的语言编码风格（例如，在 Java 与 C++ 中，您在括号中使用不同的风格；根据特定的语言约定进行选择）
3. 始终对发生的事情/原因发表评论。
4. 但是不要用注释污染代码。
5. 如果可以，请尝试集成设计模式。它有助于可重用性和可维护性
6. 不要把所有东西都放在一种方法中。每个方法都应该做一件事并且做得非常好（这也使方法更易于阅读/理解/测试/调试）
7. 不要在代码中放入硬编码的字符串
8. 将应用程序数据和应用程序代码分开。即尽量不对您的代码进行硬编码配置。
9. 不要试图比编译器更聪明。编写其他人也可以理解的代码，并让编译器进行任何优化
10. 以显示您意图的方式编写代码。编写代码，在 7 个月内您可能需要对其进行调试，或者其他人可能需要修复/增强它。7 个月后你无法记住你为什么做了某事（评论很好，但有时不够好）。更不用说那个试图修复你的代码的可怜人了

我相信还有很多，但我相信这些在任何语言中都很有用