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. 代码可读性影响
   开发者通常会在注释前后添加空行来提高代码的可读性，这种自动移除可能会破坏代码的视觉结构。

解决方案

该问题已被修复，修复方案主要做了以下改进：

1. 精确规则作用范围
   确保规则只处理真正位于大括号前后的空行，而不是函数体内部的空行。

2. 保留注释相关空行
   特别处理注释前后的空行，认为这些空行可能是开发者有意为之的格式安排。

最佳实践建议

对于使用 Swift-Format 的开发者，建议：

1. 了解各个格式化规则的具体行为
2. 对于重要的注释块，考虑使用空行来增强可读性
3. 定期更新 Swift-Format 版本以获取最新的规则改进

这个修复体现了代码格式化工具在精确性和开发者意图尊重之间的平衡，确保了工具既能够执行一致的代码风格，又不会过度干扰开发者有意为之的代码布局。