Swift-Format 中 NoEmptyLinesOpeningClosingBraces 规则的注释处理问题分析

在 Swift 代码格式化工具 Swift-Format 中，NoEmptyLinesOpeningClosingBraces 规则用于控制函数体开头和结尾的空行处理。该规则的设计初衷是移除紧邻大括号之后的空行，但在实际应用中，当函数体以注释开头或结尾时，会出现一些不符合预期的格式化行为。

问题现象

当启用 NoEmptyLinesOpeningClosingBraces 规则时，以下两种情况的空行会被意外移除：

1. 函数体结尾有注释的情况：

// 格式化前
func foo() {
  let x = 1
  
  // let y = 2
  // let z = 3
}

// 格式化后
func foo() {
  let x = 1
  // let y = 2
  // let z = 3
}

2. 函数体开头有注释的情况：

// 格式化前
func foo() {
  // let w = 0
  
  let x = 1
}

// 格式化后
func foo() {
  // let w = 0
  let x = 1
}

问题分析

从技术实现角度来看，这个问题源于规则对"空行"定义的边界条件处理不够完善。严格来说，这些被移除的空行并不直接位于大括号之后或之前，而是位于注释与代码之间。开发者通常会在注释前后保留空行以提高代码可读性，这种格式化行为会破坏代码的原有结构。

解决方案

该问题已被修复，修复方案主要调整了规则的判断逻辑：

1. 明确区分真正位于大括号后的空行和位于注释后的空行
2. 保留注释与代码之间的空行，因为这些空行通常是开发者有意为之的格式
3. 仅处理紧邻大括号的空行，不影响其他位置的代码布局

最佳实践建议

对于 Swift 代码格式化，建议开发者：

1. 对于重要的注释块，特别是文档注释或节分隔注释，前后保留空行
2. 使用最新版本的 Swift-Format 工具，以获得更智能的格式化处理
3. 在团队中统一格式化规则配置，避免因工具版本差异导致代码风格不一致

这个修复体现了代码格式化工具在精确性和灵活性之间的平衡，既保持了代码整洁性，又尊重了开发者的格式意图。