cargo readme:从文档字符串生成README.md 源码

货物自述文件 从文档注释生成README.md。 Cargo子命令,可从板条箱的文档注释中提取文档,可用于填充README.md。 安装 cargo install cargo-readme 动机 在编写文档时,通常必须显示如何使用软件的示例。 但是,如何确保所有示例都能正常运行? 难道我们没有忘记在重大更改后更新它们,并给我们(可能是新的)用户留下了他们必须自己弄清楚的错误吗? 使用cargo-readme ,您只需编写rustdoc,运行测试,然后运行: cargo readme > README.md 就是这样! 你README.md填充了从您的文档注释内容lib.rs (或main.rs )。 用法 让我们来看看下面的锈文件: //! This is my awesome crate //! //! Here goes some other description of w