微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

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

假设我在 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.rsMY_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 举报,一经查实,本站将立刻删除。