Rustfmt中宏展开导致的文档注释缩进问题分析

在Rustfmt格式化工具中存在一个关于宏展开导致文档注释缩进异常的问题。这个问题主要出现在使用concat!宏与#[doc]属性结合的场景中。

问题现象

当开发者使用如下代码模式时：

macro_rules! define_descriptor {
    ($doc:literal) => {
        pub struct Foo;
        impl Foo {
            #[doc = concat!(
                "Foo ", $doc, " bar."
            )]
            pub fn new() -> Self {
                Self
            }
        }
    };
}

每次运行rustfmt时，concat!宏内部的字符串内容都会额外增加一层缩进。这种非确定性的格式化行为会导致代码版本控制中出现不必要的变更。

技术背景

这个问题源于rustfmt在处理宏展开时的特殊行为。具体来说：

1. #[doc]属性通常用于生成文档注释
2. concat!宏用于在编译时连接字符串
3. 当两者结合使用时，rustfmt的格式化逻辑出现了递归缩进的问题

临时解决方案

目前推荐的临时解决方案是将concat!宏调用封装到另一个宏中：

macro_rules! doc_concat {
    ($doc:literal) => (concat!("Foo ", $doc, " bar."));
}

// 使用方式
#[doc = doc_concat!($doc)]

这种方法通过间接调用避免了rustfmt的直接处理，从而规避了缩进问题。

影响范围

这个问题主要影响：

1. 使用宏生成文档注释的项目
2. 需要频繁运行rustfmt的开发环境
3. 对代码格式一致性要求严格的团队

最佳实践建议

在问题修复前，建议开发者：

1. 避免直接在#[doc]属性中使用复杂的宏调用
2. 考虑使用文档注释(///)替代#[doc]属性
3. 对宏生成的文档内容进行预处理

这个问题已经被确认为已知问题的重复报告，开发团队正在处理中。开发者可以关注rustfmt的更新以获取修复进展。