小事，大影响

Source: Dev.to

结尾逗号

我想谈一个非常显而易见的话题：结尾逗号。你们中的很多人已经在使用它们，甚至在意它们，因为在定义函数或类，或在调用它们时，在最后一个参数后面加一个逗号感觉很自然。这只是我的自我反思，我尝试为自己整理并确定这一点。

结尾逗号现在已经是一个基本概念，但我们需要稍微回顾一下它们出现的原因。第一个在语法中允许逗号作为分隔符的编程语言是 Perl 的第一个版本，由 Larry Wall 于 1987 年 12 月设计。最初文档中并未提及它，但语法本身并不产生问题。直到 Perl 4（1991）才在文档中明确说明。

此后，结尾逗号的概念开始出现在许多语言中，通常范围有限（Python、Ruby、JavaScript、C#）。随着 Git（2005 年） 的发明，这一局面迅速改变。随着这套版本控制系统的日益流行，结尾逗号从单纯的语法便利转变为一种团队协作优化手段，能够让 diff 更小、合并冲突更少。从那时起，大多数现代语言都对结尾逗号提供了广泛支持（Go、Rust、Swift、Kotlin、TypeScript），或至少加入了有限支持（C++、PHP）。

一个有趣的事实是 Java 中对结尾逗号的支持非常有限。从 Java 4 起在枚举中允许使用，从 Java 8 起在数组初始化器和注解参数中允许使用。在 Kotlin 中，结尾逗号从 1.4 版（2020）开始出现。

为什么使用尾随逗号？

没有任何强制要求我们使用它们；代码无论是否带有尾随逗号都能编译并运行。问题出现在团队协作时，尤其是多个人并行编辑同一代码库时。简单的改动——比如向构造函数添加一个新参数——可能在本应没有冲突的地方产生合并冲突。冲突产生的原因是缺失或多余的逗号会改变相邻行的内容，即使新参数本身并未与现有逻辑冲突。

这些不必要的冲突会浪费时间：解决冲突、重新运行流水线，或在本地切换分支（暂存进度、同步项目等）都会增加额外开销。

如果你不在意尾随逗号，可能会一次又一次地遇到这个问题。

让尾随逗号成为强制要求 ktlint

解决方案很简单：让 ktlint 将缺失的逗号视为错误，并阻止包含该问题的 PR 合并。

配置 .editorconfig

为了让每位团队成员都遵守此规则，需要在受版本控制的 .editorconfig 文件中进行相应配置。相关标志默认已启用，但可以显式设置：

# .editorconfig
…
ij_kotlin_allow_trailing_comma = true
ij_kotlin_allow_trailing_comma_on_call_site = true
…

• ij_kotlin_allow_trailing_comma — 控制 声明（构造函数参数、函数参数等）中的尾随逗号。
• ij_kotlin_allow_trailing_comma_on_call_site — 控制 调用（调用构造函数、函数等）时的尾随逗号。

Kotlin 的风格指南强烈推荐在声明中使用尾随逗号，而在调用处的使用则交由团队约定。参见官方的 Kotlin coding conventions – Trailing commas。

我个人更倾向于在两种情况下都使用尾随逗号，以保持一致性并防止合并冲突。配置好 ktlint 后，你可以用一条命令格式化整个代码库：

./gradlew ktlintFormat

该命令会在适当的位置添加缺失的尾随逗号，随后你可以将这些更改作为一次干净的提交提交。我建议尽快完成此操作，并让全体成员在更新后的 devel（或 main）分支上 rebase。

为什么在 Kotlin 中启用尾随逗号？

当你从 develop 分支创建新分支时，如果该分支历史较长，后期可能会遇到合并冲突。尾随逗号可以帮助避免这些冲突，使代码维护更加轻松。

在 Android Studio 中启用尾随逗号

1. 打开 Settings → Editor → Code Style → Kotlin → Other。
2. 勾选 Use trailing comma。

现在每次使用 Option + Command + L 重新格式化代码时，Android Studio 会在适当的位置添加尾随逗号。

• 默认情况下，尾随逗号仅在 声明 中添加。
• 若要在 调用点 启用它们，请在 .editorconfig 文件中添加以下标志：

ij_kotlin_allow_trailing_comma_on_call_site = true

对参数排序的实际好处

当你有许多参数并需要重新排序时（例如使用 Option + Command + Arrow Up/Down），如果最后一个参数缺少尾随逗号，操作可能会中断。没有逗号会导致编译错误；有了逗号，排序就能顺畅进行。

Additional advantages

• 一致性 – 参数列表中的每一行看起来相似，使得以后编辑或复制‑粘贴更容易。
• 安全性 – 尾随逗号不会影响编译后的字节码；它纯粹是源码层面的便利。
• 合并冲突减少 – 当协作者添加或重新排序参数时，差异（diff）更少。

尾随逗号是一个小而安全的改进，可以让 Kotlin 代码更方便、出错率更低。我已自行关闭此问题，并将在需要为在 Kotlin 中使用尾随逗号辩护时回顾本文。