Lib.rs

从 markdown 文件生成 Rust 模块文档。

将模块文档应用到源文件中，从 markdown 文件开始。此二进制文件接受一个 markdown 文件，并在源文件前添加模块文档注释（//!）。根目录中有一个配置文件（modoc.config），它定义了哪些 markdown 文件应该添加到哪些源文件中，采用单输入多输出的方式。

要开始使用，请使用 cargo 安装二进制文件。

cargo install cargo-modoc

需要设置配置文件。

# Commends are allowed
"README.md" = [ "src/main.rs", "src/lib.rs" ]

单个 markdown 文件可以应用到多个源文件。

运行二进制文件将 markdown 内容写入源文件。

cargo modoc

二进制文件将读取 markdown 文件的内容，并在源文件前添加行注释（//!）。如果源文件中存在以 //! 开头的行，则这些行不会包括在内（因此文档将被覆盖）。