知识卡片
选库说明与接口文档服务不同读者
选库读者需要用途、适用场景和限制,已采用库的读者需要具体接口与示例。README与crate级API文档可分别承担这两种任务,再互相链接。不要把同一份简短介绍当作所有文档,也不要把完整API列表当成足够的项目介绍。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- Chapter 5. Tooling Published Crate Documentation · 查看原书依据
Published Crate Documentation If you publish your crate to crates.io, the documentation for your project will be visible at docs.rs, which is an official Rust project that builds and hosts documentation for published crates. Note that crates.io and docs.rs are intended for slightly different audiences: crates.io is aimed at people who are choosing what crate
参考来源
- 位置:《Effective Rust 35 Specific Ways to Improve Your Rust Code (David Drysdale)》第5章《Published Crate Documentation》(spine9;extracted/Effective Rust 35 Specific Ways to Improve Your Rust Code (David Drysdale)/_epub-src/OEBPS/ch05.html;u137-ch05-004)。
- 结论依据:原文在“Published Crate Documentation”附近的定义、例子或代码支撑本卡核心说明:选库读者需要用途、适用场景和限制,已采用库的读者需要具体接口与示例。边界按已读前提解释;示例未执行。
- 原始内容:Published Crate Documentation If you publish your crate to crates.io, the documentation for your project will be visible at docs.rs, which is an official Rust project that builds and hosts documentation for published crates. Note that crates.io and docs.rs are intended for slightly different audiences: crates.io is aimed at people who are choosing what crate