Rune语言格式化工具中的注释缩进问题解析

Rune语言作为一门新兴的脚本语言，其开发工具链的完善程度直接影响开发者体验。最近在Rune 0.13.3版本中发现了一个关于代码格式化工具的有趣问题，值得深入探讨。

问题现象

当代码块中包含特定结构的注释时，格式化工具会出现非预期的缩进处理。具体表现为：

原始代码：

pub fn test(something, cmd) {
    if something {
        // A comment
        cmd.something();
        // TODO: Also add something else
    }
}

经过格式化后：

pub fn test(something, cmd) {
    if something {
        // A comment
        cmd.something();
    // TODO: Also add something else
    }
}

可以看到，位于代码块末尾的TODO注释被错误地减少了缩进层级，与代码块起始大括号对齐，而非保持与内部语句相同的缩进级别。

技术分析

这类问题通常源于格式化工具对注释节点的处理逻辑不够完善。在抽象语法树(AST)解析过程中，注释作为非功能性节点，其位置信息需要特殊处理。特别是：

1. 尾随注释处理：位于代码块最后一个语句后的注释容易被误判为属于代码块结束标记而非内部语句
2. 上下文感知不足：格式化工具可能没有充分考虑注释与周围代码的语义关联
3. 缩进规则冲突：当遇到特定注释标记(如TODO)时，可能触发了不同的缩进策略

解决方案

该问题已在内部修复(#790)，推测修复方案可能涉及：

1. 改进注释节点的AST定位逻辑
2. 增强对代码块内注释的上下文感知
3. 统一注释的缩进处理策略

对开发者的启示

这类格式化问题虽然不影响代码执行，但会影响可读性。开发者应注意：

1. 定期更新工具链以获取修复
2. 对于关键注释，可考虑使用更显眼的标记方式
3. 在团队开发中统一格式化规则

Rune作为年轻语言，其工具链正在快速迭代，这类问题的及时修复展现了社区对开发体验的重视。随着语言生态的成熟，类似问题将越来越少。