如何提高 Swift 代码的可读性？

---

在本教程中，您将学习如何在 Swift 语言中提高代码的可读性。

在编写代码时，您可以遵循多种技巧。通过遵循这些方法，您将能够为自己和其他开发人员编写更易于理解的代码。

使用注释

这是我们应该做的最重要的事情。在编写代码时，我们经常编写逻辑和计算。当我们开始时，我们的大脑中拥有所有内容，但是一个月后，肯定很难记住所有内容，尤其是在大型应用程序中。

代码通常在单行上进行注释。因此，我们能够更好地理解一段时间前编写的代码或逻辑。在注释中，不要仅仅描述一行代码的功能；添加解释和见解。

一种不太常用的注释类型是块注释。这些注释通常用于将许可信息和版权信息放在文件的顶部，但如果您需要编写多行代码来解释代码，它们也可能很有用（尽管一个好的经验法则是，如果您需要用那么多文字来解释代码，它可能不够易读）。

要创建块注释，请以正斜杠、星号开头，然后是您的代码。准备好结束注释后，只需放置一个星号，然后是另一个正斜杠。

代码重用

代码重用是那些编程概念之一，它可能比最初看起来复杂得多。虽然很容易争论说应该不惜一切代价避免代码重复，并且应该尽可能地重用和共享实现。

可重用代码的优势

• 节省大量代码行

• 易于在一个地方进行更改

• 易于理解完整的功能

• 降低错误风险

• 维护编码标准

有意义的命名

在 Swift 中，最有效的方法是根据对象在代码中扮演的角色来命名对象。例如，如果一个名为 apple 的变量类型是 Apple，但 apple 充当动物的食物，则可以将其命名为 food。

有时，我们可能会倾向于赋予一个应该专门化的对象许多职责。这可能使您的应用程序模块化程度降低，并且对于任何阅读代码的人来说都会更加混乱。根据对象的功能对其进行命名可以帮助您记住只为对象赋予其负责的角色。

Apple 推荐的命名约定

属性、变量和常量的名称应读作名词。

布尔方法和属性的使用应读作对接收者的断言。

描述某物是什么的协议应读作名词。

使用设计模式

在生产级应用程序中，开发人员使用设计模式以一种可以更改且更易读的方式来构建代码。让我们讨论一些您可以在下一个 iOS 应用程序中使用的一些设计模式。

尽管这听起来像是老生常谈，但这确实是您编写应用程序的基础。假设您正在建造一栋房子，您的梦想之家。这栋房子有五层楼高，因此，如果您不打下坚实的基础并遵循蓝图，它可能会倾倒。iOS 应用程序的基础是您选择的设计模式或模式。让我们看看两种最常用的模式。

一些流行的设计模式如下所示

• MVC − 模型-视图-控制器或 MVC 设计模式是行业标准。它将代码的每个部分分成三个部分：模型、视图和控制器。模型本质上是应用程序的数据。视图仅负责可视化数据。控制器从模型接收数据，然后将其发送到向用户显示数据的视图。

• MVVM − 使用标记语言或 GUI 代码，此架构可以实现用户界面的开发与分离。MVVM 的完整形式是模型-视图-视图模型。MVVM 中的视图模型是一个值转换器，这意味着视图模型负责以一种可以轻松管理和呈现对象的方式公开模型中的数据对象。

• 单例 − 单例是类的单个实例，它始终存在于内存中。

代码组织

您应该在正确的目录结构中组织文件。这使得查找和跳转到任何文件变得容易，而无需搜索它。根据应用程序中的模块创建正确的目录。每个模块都可以拥有一个单独的文件夹来组织与该模块相关的文件。通过正确的代码组织，您可以轻松导航到文件。

您还可以在文件级别组织代码。例如，在一个文件中，可能存在许多属性和函数以及其他内容。因此，您可以使用文件中的代码注释对其进行组织。下面是一些如何在文件中组织代码的示例 -

// TODO: <To-Do Item>: Mark any function or properties that need some work on it.
// FIXME: <Issue Title>: Mark your issues with this annotation to fix them later.
// MARK: <Section Title>: Mark your section with this annotation to categorize the code in a file.

结论

如您所见，使您的代码更具可读性和组织性并不难。当您付出努力这样做时，您将能够轻松修改代码，并使您的代码更容易被其他人理解。