不要那么做，编写更好的功能-CSDN博客

本文通过一个实际案例，探讨了在软件开发中编写高质量函数的重要性。文章提出了四个关键原则：函数应小巧、清洁、简单且专注于单一职责。这些原则不仅提高了代码的可读性和可维护性，还促进了更高效的团队协作和软件开发过程。

一天早晨，当我在办公室厨房里加热早餐时，我的一位同事走进来，我们开始进行一些闲聊。我要打电话给这个同事弗雷迪。弗雷迪（Freddie）在公司工作了几周，所以自然而然地，我问他情况如何。从那以后，他继续说的话一直困扰着我。他叹了口气，谈到自己在理解自己正在从事的特定项目上继承的代码库时遇到了麻烦。

然后，弗雷迪（Freddie）花了很多时间告诉我，由于盯着一个毫无意义的函数的庞然大物而变得烦躁和疲倦。我问他是否尝试过与在他之前从事该软件工作的队友进行核对，他对此轻笑着回答，然后说：“（队友的名字）也不知道。他像我一样专心地盯着它，只是说他没有写。

与房地美交谈后，我对自己说了两件事。第一个是，“不要那么做！”。也就是说，不要像使弗雷迪受苦的人那样。第二个是“编写更好的功能”。那是不像那个家伙的唯一方法。我敢肯定，有无数的房地美必须继承，理解和重构软件项目中编写错误的功能。精心设计的软件会关注小型单位（或方法），例如微观层面的功能，而不仅仅是宏观层面的整体功能。

我在很短的编码时间内编写了很多错误的函数，因此我开始认真考虑在此特定领域进行改进。以下是一些我已经（并且仍在学习）的指南和方法，可以从经验丰富的专业人员，同事和其他推荐的来源中应用。

了解功能

定义事物始终是一个不错的起点。功能是编程的程序。如果您正在寻找比这更冗长的内容，则必须去Google。软件系统将在不同程度上包含功能。可能是您正在开发面向对象设计的软件，其中的功能将存在于组成系统的类中，并且这些功能将根据它们所处的类的状态起作用。或者您的系统是面向功能的设计，其中系统被分解为一组作用在集中状态的交互功能。无论采用哪种方法，功能都是存在的，因为我们需要分解解决方案的概念，而在这种分解的非常低的水平上，我们会发现这些用于特定目的的小单元。

函数应该很小

缩小体积可使函数更易于阅读，理解，测试和调试。我不会给你一个神奇的数字。一些专家会说不超过15条线，另一些专家会说不超过25条线。这可能是您必须在团队中决定的事情。重要的是要记住保持功能小的原则的原因。

可读性 ：一个函数通常将具有一个签名和一个块代码，该代码在调用或调用该函数时执行。该函数块中的代码行较少，有助于轻松阅读并了解该函数的意图。

可理解性 ：较小的功能有助于减少偏离功能主要目的的可能性。函数的概念或目的越线性，它就会越容易理解。

可测试性 ：简短的方法变化少，这意味着它们更易于测试

这是一个旨在检查承载令牌有效性的函数示例：

功能应该干净

它可能不会比这更模棱两可了。但是，这与代码样式，缩进或变量名长度无关。这是关于可理解性。弗雷迪（Freddie）是否能够查看您的功能，弄清它的意图并能够在不花大量时间的情况下进行修改？

归结为代码的可维护性，可维护代码构成了可维护软件的主要骨干。我知道还有其他一些属性可以用来定义主观的干净代码，这是您和您的团队可以决定的。

功能应该简单

我的技术负责人经常对我说：“如果（功能）需要很多努力，您就停下来并重新思考您的解决方案”。在我们的领域中，努力不应该总是被称赞，因为努力常常会产生复杂的事情。