Rustdoc中如何将模块引入文档注释作用域？

方法1：模块级导入配合#[doc(no_inline)]（推荐） #

在你编写文档的模块顶部（而非文档注释内部）导入目标类型，并添加#[doc(no_inline)]属性，就能在文档注释里直接用短名称引用：

// 模块顶部添加此代码
#[doc(no_inline)]
pub use modA::subB::subC::MyStruct;

/// A struct [`MyStruct`] is very beautiful.
pub fn demo_func() {}

这个属性会避免把MyStruct的定义内联到当前模块文档，同时让短名称在注释中生效。

方法2：文档注释内定义链接别名 #

如果不想在模块级别导入，可在单段注释里定义别名复用：

/// A struct [`MyStruct`][my_struct] is very beautiful.
/// Another mention of [`MyStruct`][my_struct] here.
///
/// [my_struct]: modA::subB::subC::MyStruct
pub fn demo_func() {}

适合仅在少数注释中需要简化引用的场景。

注意点 #

你尝试的/// #[use ...];写法无效，Rust文档注释不支持在内部直接写use语句。

内容的提问来源于stack exchange，提问作者Samuel Hapak