统一社会信用代码编写规则_我编写干净代码的4条规则-CSDN博客

统一社会信用代码编写规则

任何开发人员最有价值的技能之一就是编写简洁的代码。语言和框架将您置于特定的框架中，但是在编写高质量代码时，您需要自己构建框架并表现出一定的自律性。错误的代码仍然会编译，这就是为什么某些开发人员只要能够使程序正常工作就不会过多关注。

互联网上有很多书籍和内容，您可以遵循不同的规则和做法。只要您清楚要构建的内容，它们就很棒，但通常会更改规范或需要更改代码库的某些部分。这正是代码开始发臭的时候。拼写这些类确实会让您感到沮丧，您只想让所有这些都能运行并每天调用它。重构可以等待，明天就可以完成。除非当然，除非您紧急注意一些紧急修复措施，否则您会忘记它。

在流动条件下很难编写适当的代码，这就是为什么我创建了一套日常编码中要遵循的规则，以减轻重构时遇到的麻烦。

保持低缩进

您每天编写的主要代码是什么？循环，条件语句，尝试-捕获块等。实际上，通常必须嵌套这些内容-您有一个条件语句，以检查验证是否通过，然后您将遍历所有变量。在其中，您还有另一个条件语句，以查看是否已达到某个变量以使其值发生变化。这种情况经常发生，导致您的代码看起来像一棵圣诞树。

高缩进会引起混乱，开发人员一眼就无法在逻辑上分离代码。如果您正在编写JS，更不用说块作用域变量了。尽可能减少缩进，将逻辑分为其他方法，并在可能时进行重组。这是我喜欢在日常编码中使用的东西。而不是像这样编写验证（后面是伪代码）：

if (validation.isSuccessful()) { // do sth. } else { // do sth. else // do sth. else }

我这样做：

if (validation.fails()) { // do sth. return response } // do sth. else; if it reaches here, validation was successful // do sth. else; if it reaches here, validation was successful

订购您的代码

我不必告诉您水平和垂直代码结构的重要性。在逻辑上分开的代码中，我永远不会超过一个空行。如果您必须澄清一些内容，请使用注释，但是将2–3个空白行卡在中间以分隔逻辑肯定会要求为此而另辟method径。代码变得更难阅读，并跟踪您正在查看的内容。

至于水平结构，请避免使用过长的线，但同时不要将所有内容折叠到比应有的空间小的位置。不要保留这些多余的字节，并在其他运算符之前留一个空格。

管理方法长度

我已经阅读了很多关于方法应该使用多长时间以及何时拆分它们的知识。许多人说，一种方法应该足够简短，以便能够在不滚动的情况下将其放入屏幕。我遵循的规则是，方法应该做一件事情—顾名思义就是这样做。是的，只要方法将某些内容存储到数据库中，它的时间可能就会更长。您需要验证输入，准备查询，执行它们并处理错误。保留方法中最具体的部分本身，并抽象所有其他内容。这使您可以使方法更短并重用常用功能。如果您设法保持类的流动，则可获得加分，因此您在方法之间的跳转不会过多