rdoc

一个简单的 rustc 插件，用于在单独的文件中托管您的项目文档。

夜间版

由于这是一个编译器插件，因此需要 Rust Nightly 版本。

如何使用它

在您的 Cargo.toml 中添加以下内容：

[dependencies]
rdoc = "*"

在您的 lib.rs 或 main.rs 文件中，将以下内容放置在顶部：

#![feature(plugin)]
#![plugin(rdoc)]

假设有一个名为 doc.md 的文件位于您的目录顶部，在您的代码中，将以下内容放置在您想要进行文档化的项目上方：

#[rdoc = "doc.md"]
pub fn print_hello() {
    println!("Hello!");
}

在编译时，此注释将转换为包含 doc.md 内容的文档注释，适用于下方的任何项目。无需指定特定文件类型或在该文件中放置 /// 注释。只需编写文档文本，rdoc 会为您处理其余部分！您只需提供有效的注释路径即可。

许可证

许可协议为以下两种之一：

• Apache 许可证 2.0 版（《LICENSE-APACHE》或 http://www.apache.org/licenses/LICENSE-2.0》）
• MIT 许可证（《LICENSE-MIT》或 http://opensource.org/licenses/MIT》）

任选其一。

许可协议

除非您明确表示，否则任何有意提交以包含在您的工作中的贡献（根据 Apache-2.0 许可证定义），均应双许可，如上所述，不附加任何额外条款或条件。