1

假设我在 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.rsand 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 等？我也看到了这个类似的问题，目前没有答案。

4

0 回答 0