文件名称：cargo-readme:从文档字符串生成README.md
文件大小：48KB
文件格式：ZIP
更新时间：2024-06-02 02:20:53
rust readme cargo-subcommand cargo-readme Rust
货物自述文件 从文档注释生成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
【文件预览】：
cargo-readme-master
----LICENSE-MIT(1KB)
----Cargo.toml(651B)
----.github()
--------workflows()
----Cargo.lock(17KB)
----src()
--------main.rs(5KB)
--------readme()
--------config()
--------lib.rs(3KB)
--------helper.rs(4KB)
----README.tpl(639B)
----LICENSE-APACHE(11KB)
----README.md(3KB)
----docs()
--------uml()
----tests()
--------alternate-input.rs(1KB)
--------multiline-doc.rs(1KB)
--------project-with-version()
--------multiple-bin-fail.rs(404B)
--------no-entrypoint-fail.rs(358B)
--------append-license.rs(1KB)
--------entrypoint-resolution()
--------project-with-version.rs(502B)
--------no-entrypoint-fail()
--------badges.rs(2KB)
--------test-project()
--------entrypoint-resolution.rs(1KB)
--------alternate-template.rs(1KB)
--------no-template.rs(1KB)
--------default-behavior.rs(1KB)
--------.gitignore(11B)
--------multiple-bin-fail()
--------badges()
----.gitignore(21B)