ReScript编译器参数注释格式化问题解析

在ReScript编译器项目中，开发者们发现了一个关于函数参数注释格式化的有趣问题。当开发者尝试通过注释方式临时移除函数参数时，格式化工具会意外地完全删除这些注释内容，导致代码意图丢失。

问题现象

在ReScript代码中，当开发者使用以下两种方式注释函数参数时：

f(
  // a,
  // b,
)

或者

f(
  // a,
  // b,
  ()
)

经过格式化后，这些注释会被完全移除，代码简化为：

f()

技术分析

这个问题实际上反映了格式化工具在处理注释时的逻辑缺陷。在大多数现代编程语言中，注释作为代码文档和临时标记的重要组成部分，格式化工具通常会保留它们的原始位置和内容。

ReScript格式化工具当前的行为可能是由于：

1. 将注释视为与参数绑定的附属内容，当参数被移除时连带删除
2. 没有为独立的注释节点设计专门的保留逻辑
3. 在空参数列表情况下过度简化输出

解决方案讨论

项目维护团队经过讨论后，确定了以下设计原则：

1. 保持注释的原始位置（"as is"原则）
2. 尊重开发者显式添加的注释布局
3. 不自动重新定位注释到函数调用之外

这种处理方式有几个优势：

• 符合开发者临时注释参数的预期
• 最小化格式化带来的代码变动
• 保持与带参数时相似的代码结构

对开发者的建议

虽然这个问题会在后续版本中修复，但开发者目前可以采取以下临时解决方案：

1. 使用块注释而非行注释
2. 在注释后保留一个虚拟参数
3. 暂时禁用格式化功能

这个问题的发现和解决过程展示了ReScript社区对代码质量和开发者体验的重视，也提醒我们在使用任何格式化工具时都应该了解其边界情况和特殊行为。