Question

在Rust的macro_rules中是否可以匹配文档注释？

我有一个宏，它为bindgen创建的一堆C常量生成一个枚举：

macro_rules! id_enum {
    ( enum $name:ident: $typ:ty { $( $enum_name:ident => $value:expr ),* , } ) => { ... }
}

我想用文档注释（///注释）为每个注释添加注释，但这需要我的宏与文档注释匹配。有可能吗？

Answer 1

文档注释将转换为表单的属性

#[doc = "documentation text"]

，并且可以按照其翻译形式进行匹配：

macro_rules! print_doc {
    (#[doc = $doc:expr]) => {
        pub fn foo() {
            println!($doc);
        }
    }
}

print_doc!(
    /// gloink
);

fn main() {
    foo();
}

如果要以修改后的形式发出文档注释，则需要在宏中使用属性语法，如此答案中所述：

Generating documentation in macros

要将原始文档注释与注释连接起来，可以使用标准库中的宏concat!()。但是，属性内部不允许使用宏调用，因此您需要一个辅助宏，例如

macro_rules! annotated_func {
    ($doc:expr) => {
        #[doc = $doc]
        pub fn foo() {
            println!($doc);
        }
    }
}

macro_rules! print_doc {
    (#[doc = $doc:expr]) => {
        annotated_func!(concat!($doc, "\nannotation"));
    }
}

匹配文档注释的宏规则

1 个答案: