Swift风格指南：为什么要打扰？

您已决定编写样式指南。 为什么？ 写原因的原因是什么，您如何说服团队成员遵循样式指南？

最近，我正在大型代码库中进行此过程。 我想提出一些合理的理由来推动它，而不只是预感它将使事情变得更好。

我得出的结论是，您实际上不需要样式指南。 但是，指南可以减少开发人员的认知负担。 它还具有使您的代码看起来整洁的漂亮副作用。

看到好处的最简单方法是类比英语。

首先是一个没有标点符号的块：

有大量的编码约定，有关大量示例和讨论的信息，请参见编码样式。常见的编码约定可能涵盖以下领域：注释约定缩进样式约定行长约定命名约定编程实践编程原则编程规则拇指编程风格约定

其次，一个带有标点符号的块：

有许多编码约定。 有关大量示例和讨论，请参见编码风格。

通用编码约定可能涵盖以下领域：

*评论约定
*缩进样式约定
*行长约定
*命名约定
*编程习惯
*编程原理
*编程经验法则
*编程风格约定

这个简单的示例显示了一段文本上的格式差异。 它强调了样式指南的要点：必须使代码更清晰，以供开发人员阅读。

当我上大学时，我曾经使用在游戏编程中学到的技术来编写我认为很糟糕的作业。 诸如迭代数组指针而不是使用for循环之类的技术。 我最终为此受到了惩罚，因为我的主管发现代码难以理解并且不熟悉这些技术。

考虑到这样的普遍格言，即代码被读取的次数超过了编写的次数，我认为提高代码的清晰度很重要。

这意味着我们所有人都应尝试以相同的方式编写代码并以相同的方式设置其格式。 幸运的是，我们有Apple和Xcode在这里指导我们。 我们只需要遵循Apple的风格，并在Xcode中使用自动完成风格，我们将以成千上万的开发人员可以理解的方式进行编写。

如果这还不够的话，Realm还创建了出色的SwiftLint用于执行样式指南。 另外，Swift-Clean的工作人员还会进行调查，您可以在其中轻松生成样式指南，并将其与其他开发人员的答案进行比较。

那么样式指南是吗？ 它们不是必需的，但是如果您重视所做的事情并希望使代码更好，那么这是提高项目整体质量的简单方法。

只是不要成为您的风格指南的奴隶，比如用英语写作时，有时我们会出现语法错误，而有时这些错误是更好的选择。