SQL Formatter 项目中的 Transact-SQL 块注释格式化问题解析

在 SQL 代码格式化工具 SQL Formatter 中，发现了一个关于 Transact-SQL 块注释格式化的有趣问题。这个问题不仅影响了 Transact-SQL，还波及到了 PostgreSQL 和 DB2 for IBM i 等数据库方言。

问题的核心表现是：当代码中包含特定格式的块注释时，格式化工具会错误地插入空格，导致注释语法被破坏。具体来说，类似 /** block comment **/ 这样的注释会被错误地格式化为 / * * block comment * * /，这在语法上是不正确的。

深入分析这个问题，我们发现它实际上与嵌套块注释的解析逻辑有关。问题的触发点特别出现在注释结束标记 **/ 上。即使是简单的 /* block comment **/ 也会被错误处理，变成 / * block comment ** /，这种格式化结果显然破坏了原始代码的语义。

这个问题的修复方案已经包含在 SQL Formatter 的 15.3.2 版本中。对于开发者而言，理解这类问题的本质非常重要，因为它揭示了代码格式化工具在处理特殊语法结构时可能面临的挑战。

在实际开发中，代码注释的格式一致性对于代码可读性和维护性至关重要。格式化工具本应帮助开发者保持一致的代码风格，但这类 bug 反而会引入新的问题。这也提醒我们，即使是成熟的工具，在处理边缘情况时也可能需要特别关注。

对于使用 SQL Formatter 的开发者，建议在升级到最新版本前，可以暂时通过启用"密集运算符"(dense operators)选项来规避这个问题，虽然这会产生 /**block comment**/ 这样不带空格的紧凑格式，但至少能保证语法正确性。

这个案例很好地展示了开发工具与特定语法规则交互时可能出现的微妙问题，也体现了开源社区通过 issue 跟踪和版本迭代不断完善工具的典型过程。