知识卡片
文档需要渲染与链接检查
cargo doc –open可查看生成页面,–no-deps限制到当前crate;内部链接检查帮助发现标识符拼写或路径错误。missing_docs可提示公开项缺文档,却不能判断解释质量。把适当检查纳入持续流程,同时阅读实际页面,才能发现格式与语义之外的可用性问题。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- Chapter 5. Tooling Tooling · 查看原书依据
cargo doc --open (or cargo doc --no-deps --open to restrict the generated documentation to just the current crate). You could also check that all the generated hyperlinks are valid, but that’s a job more suited to a machine—via the broken_intra_doc_links crate attribute:1 #![deny(broken_intra_doc_links)] /// The bounding box for a [`Polygone`]. #[derive(Clon
参考来源
- 位置:《Effective Rust 35 Specific Ways to Improve Your Rust Code (David Drysdale)》第5章《Tooling》(spine9;extracted/Effective Rust 35 Specific Ways to Improve Your Rust Code (David Drysdale)/_epub-src/OEBPS/ch05.html;u135-ch05-002)。
- 结论依据:原文在“cargo doc --open”附近的定义、例子或代码支撑本卡核心说明:cargo doc --open可查看生成页面,--no-deps限制到当前crate;内部链接检查帮助发现标识符拼写或路径错误。边界按已读前提解释;示例未执行。
- 原始内容:cargo doc --open (or cargo doc --no-deps --open to restrict the generated documentation to just the current crate). You could also check that all the generated hyperlinks are valid, but that’s a job more suited to a machine—via the broken_intra_doc_links crate attribute:1 #![deny(broken_intra_doc_links)] /// The bounding box for a [`Polygone`]. #[derive(Clon