怎么写出优质干净的代码

本文主要讲解“如何写出高质量、干净的代码”，感兴趣的朋友不妨看看。本文介绍的方法简单、快速、实用。让边肖带你学习如何编写高质量和干净的代码。

写干净代码的好处

让我们从编写干净代码的一些好处开始。主要的好处之一是干净的代码可以减少阅读和理解代码所花费的时间。凌乱的代码会降低任何开发人员的速度，并使开发人员的工作更加困难。代码越混乱，开发人员就需要越多的时间来完全理解它，以便使用它。此外，如果代码太乱，开发人员可能会决定停止读取代码，从头开始编写。

1.更容易开始和继续一个项目

让我们用一个简单的例子来说明这个问题。假设我们在很长时间后回到上一个项目，可能在这段时间有客户联系我们做另一个工作。现在，想象一下如果你当时没有写干净的代码，情况会有多糟糕和混乱。还有，你可以知道从一开始离开的地方开始编码有多难。

因此，我们现在必须花更多的时间在项目上，因为我们需要理解以前编写的代码。如果我们从一开始就编写干净的代码，这是可以避免的，但是现在我们必须为此付出代价。此外，旧代码非常混乱和糟糕，我们可能会决定从头开始。客户听到这些消息后可能会不高兴。

另一方面，干净的代码通常不会有这个问题。假设前面的例子正好相反，前面的代码干净优雅，需要多长时间才能理解？也许我们只需要读几分钟代码就能理解所有的工作原理，而且我们可能已经开始写了一段时间，所以这种情况下花费的精力会明显少于第一种情况，客户也不会太在意。

这是编写干净代码的第一个优点，它不仅适用于您自己的项目，也适用于其他开发人员的工作。干净的代码可以更快地开始工作，没有人需要花费数小时来研究代码。相反，我们可以直接开始工作。

2.有利于团队新员工培训

编写干净代码的另一个好处与第一个好处密切相关，即它可以让新员工更容易、更快地使用代码。假设我们需要雇佣一名开发人员，她需要多长时间才能理解代码并学会使用它？这当然要看情况。如果我们的代码很乱，写得不好，她需要花更多的时间研究代码。另一方面，如果代码干净、可读且易于理解，她将能够更快地开始工作。

有人可能会说这不是问题，因为其他开发商可以帮她。当然，这是真的，但应该只需要很短的时间，两三次或者一两天，而不是两三个星期。因此，雇佣另一个开发人员的目的是为了加快我们的工作速度，而不是放慢速度，也不是花更多的时间帮助她学习使用代码。

当我们试图写干净的代码时，别人会向我们学习，写干净的代码会更容易。当然，仍然需要留出一些时间来帮助每个新开发人员理解和理解代码。当然，我指的是几天，不是几周。此外，干净的代码将帮助团队带来更多的开发人员，同时帮助他们理解代码。简单来说，代码越简单，越容易解释，误解越少。

3.更容易遵循编码模式

需要记住的一点是，理解和学习如何使用代码是一回事。然而，这只是开始，我们需要确保开发人员愿意遵循我们的编码模式。当然，用干净的代码比乱七八糟的代码更容易实现这个目标。这一点非常重要，因为团队不仅要写出干净的代码，还要一直保持这种模式，这也需要长期思考。

另外，如果开发人员不遵循当前的编码模式呢？这个问题通常可以自己解决。假设一组人在处理相同的代码，其中一个人开始偏离标准风格。然后，团队的其他成员将推动开发人员遵循标准。她会接受这个建议，因为她不想离开这个团队。

在另一种情况下，开发人员将说服团队的其他成员采用并遵循他们自己的编码模式。如果开发者提出的编码模式更干净，能带来更好的效果，那当然是好事。事实上，编写和保持干净的代码并不意味着应该忽略任何改进它的机会。我认为我们应该始终对当前的实践保持一种改进的态度，并努力寻找改进的机会。

因此，如果一个开发人员偏离了当前的模型，并且她的模型更好，那么我们做出改变可能更合适。因此，在尝试其他模式之前，我们不应该忽视其他人的编码实践，我们应该继续寻找改进的空间。最后，第三种情况。开发商决定不采用我们的做法，也不劝说我们采用她的做法。因为她会决定离开球队。

技巧

现在除了讨论编写干净代码的好处，是时候学习一些技巧来帮助我们实现这个目标了。正如下面将要看到的，干净的代码包含并遵循一些方法。这些方法使代码更加清晰、易读、易懂和简单。当然，没有必要实现所有的方法。实施和遵循一两项措施就足以带来积极的结果。

1.编写可读的代码

的确，写出来的代码会被机器解释，但这并不意味着代码的可读性和可理解性就应该被忽略，因为将来总会有另一个人使用我们写的代码。即使其他人无法访问我们的代码，我们也可能在未来再次获取它。由于这些原因，使代码易于阅读和理解符合我们自己的利益。那么如何实现呢？

最简单的方法是使用空格。在您发布代码之前，您可以减少它，但是没有必要让它看起来很小。相反，缩进、换行和空行可以用来替代。

码结构更具可读性。当决定采用这种方式时，代码的可读性和可理解性就会显著提高。然后，看着代码就可以更容易理解它了

2.为变量、函数和方法使用有意义的名称

来看一看第二个技巧，它将帮助我们编写可理解和干净的代码。这个技巧是关于变量、函数和方法的有意义的名称。“有意义的”是什么意思?有意义的名字是描述性足够多的名字，而不仅仅是编写者自己才能够理解的变量、函数或方法。换句话说，名称本身应该根据变量、函数或方法的内容和使用方式来定义。

然而需要注意的是，使用描述性名称并不意味着可以随意使用任意多个字符。一个好的经验则是将名字限制在3或4个单词。如果需要使用超过4个单词，说明这个函数或方法需要同时执行很多的任务，所以应该简化代码，只使用必要的字符。

3.让一个函数或方法只执行一个任务

当开始编写代码时，使用的函数和方法看起来就像一把瑞士军刀，几乎可以处理任何事情，但是很难找到一个好的命名。另外，除了编写者，几乎没有人知道函数是用来做什么的以及该如何使用它。有时我就会遇到这些问题，我在这方面做的很不好。

然后，有人提出了一个很好的建议：让每个函数或方法只执行一个任务。这个简单的建议改变了一切，帮助我写出了干净的代码，至少比以前更干净了。从那以后，其他人终于能够理解我的代码了，或者说，他们不需要像以前一样花很多时间去读懂代码了，功能和方法也变得更好理解。在相同的输入下，总是能产生相同的输出，而且，命名也变得容易得多。

如果你很难找到函数和方法的描述性名称，或者需要编写冗长的指令以便其他人可以使用，那请考虑这个建议，让每个函数或方法只执行一个任务。如果你的功能和方法看起来像瑞士军刀一样无所不能，那请你执行这个方法，相信我，这种多才多艺不是一种优势。这是一个相当不利的情况，可能会产生事与愿违的结果。

附注:这种让每一个函数或方法只执行一项任务的做法被称为保持纯函数。这种编码实践来自于函数式编程的概念。

4.更容易遵循编码模式

不管多么努力地为变量、函数和方法想出有意义的名字，代码仍然不可能完全清晰易懂，还有一些思路需要进行解释。问题可能不是代码很难理解或使用，相反，其他人可能不理解为什么要实现这个函数或方法，或者为什么要以特定的方式创建它。意思是，创建函数或方法的意图还不清楚。

有时可能不得不采用非传统的方法来解决问题，因为没有足够的时间来想出更好的解决方案，这也很难用代码来解释。所以，通过代码注释可以帮助解决这个问题，也可以帮助我们向其他人解释为什么写了这个方法，为什么要用这种特定的方式来写，那么其他人就不必猜测这些方法或函数的用途了。

更重要的是，当我们使用注来解释代码后，其他人可能会找到一个更好的方法来解决这个问题并改进代码。这是有可能的，因为他们知道问题是什么，以及期望的结果是什么。如果不知道这些信息，其他人就很难创建更好的解决方案，或者他们可能不会去尝试，因为他们认为没有必要去修改创建者自己的想法。

因此，每当自己决定使用一些快速修复或非传统的方法时，要用注释来解释为什么这么做。最好是用一两行注释来解释，而不用别人来猜测。

也就是说，我们应该只在必要的时候使用注释，而不是解释糟糕的代码。编写无穷无尽的注释将无助于将糟糕的代码转换成干净的代码。如果代码不好，应该通过改进代码来解决这个问题，而不是添加一些如何使用它的说明。编写干净的代码更重要。

5.保持代码风格一致性

当我们有自己喜欢的特定编码方式或风格时，就会在任何地方一直使用它。但在不同的项目中使用不同的编码风格不是一个好主意，而且也不可能很自然地回到以前的代码，所以仍然需要一些时间来理解在项目中使用的编码风格。

比较好的方法是选择一套编码方式，然后在所有的项目中坚持使用。这样的话，回到之前的旧代码会变得更容易。当然，尝试新的编码方式是一件好事，它可以帮助我们找到更好的方法来开展工作。但是最好是在不同的实验项目或练习上尝试不同的编码风格，而不是在主要项目上进行。

另外，当我们决定做一些试验的时候，就应该尝试多次练习，应该花时间彻底地做好。只有真正确信喜欢这种做法，并且对它感到满意时，才应该去实施它。而且决定这样做的时候，最好应用在所有的项目中。是的，这需要时间，这也会促使我们正确地思考。

6.检查你的代码

这是最后一个技巧。不仅仅是编写干净的代码，还要完成最后的工作，那就是需要维护干净代码。我们应该定期检查代码，并试着改进它。否则，如果不审查和更新我们的旧代码，它很快就会过时，就像我们的设备一样。如果想让代码保持优质状态，就需要定期更新它们。

对于每天使用的代码，情况也是如此。代码会变得更加复杂和混乱，所有应该避免这种情况发生，并保持代码干净。实现这一点的唯一方法是定期检查我们的代码。换句话说，我们需要保持它。对于那些未来不再关心的项目来说，这可能是不必要的，但对其他的来说，维护代码是工作的一部分。

到此，相信大家对“怎么写出优质干净的代码”有了更深的了解，不妨来实际操作一番吧！这里是网站，更多相关内容可以进入相关频道进行查询，关注我们，继续学习！