将项目文件夹中的所有 rustdoc 注释编译为单个 Markdown 文件 示例_1示例_2

编程问答 2022-04-25

问题描述

假设我在 VSCode 项目中有以下目录结构：

- MY_EXAMPLES
 - Example_1
   - src
    - main.rs
   - Cargo.lock
   - Cargo.toml
 - Example_2
   - src
    - main.rs
   - Cargo.lock
   - Cargo.toml

现在我想编译所有 main.rs 文件中的注释。在这种情况下，这将是 MY_EXAMPLES/Example_1/src/main.rs 和 MY_EXAMPLES/Example_2/src/main.rs。请注意，我希望此解决方案可扩展，因此如果我有 10 或 20 个 Example_X 文件夹，我可以自动编译注释。

MY_EXAMPLES/Example_1/src/main.rs

/// My notes on Example 1 that I'd like to add to my README.md
fn main(){
//..
}

MY_EXAMPLES/Example_2/src/main.rs

/// My notes on Example 2 that I'd like to add to my README.md
fn main(){
//..
}

运行：

C:\Users\Primary User\Desktop\MY_EXAMPLES> cargo doc

应该创建一个如下所示的 README.md 文件：

示例_1

我想添加到我的 README.md 中的关于示例 1 的笔记

示例_2

我想添加到我的 README.md 中的关于示例 2 的注释

所以我们的 README.md 内容的通用模板类似于：

### Project Rootdir
rustdoc comments

rustdoc 有没有类似 JSDoc 等的模板系统？ 我也看到了 this 类似的问题，目前没有答案。

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）

rustrustdoc