1.
What is rustdoc?
2.
Command-line arguments
3.
How to read rustdoc output
3.1.
In-doc settings
3.2.
Search
4.
How to write documentation
4.1.
What to include (and exclude)
4.2.
The #[doc] attribute
4.3.
Re-exports
4.4.
Linking to items by name
4.5.
Documentation tests
5.
Rustdoc-specific lints
6.
Scraped examples
7.
Advanced features
8.
Unstable features
9.
Deprecated features
10.
References
轻
Rust
煤
海军
香鱼
rustdoc 指南
参考
有很多很棒的
rustdoc
参考资料。如果您知道其他优秀的资源,请提交一个 pull request!
官方
学习 Rust
Rust 示例
Rust 参考手册
RFC 1574:更多 API 文档约定
RFC 1946:Rustdoc 内部链接
社区
API 指南
GitHub 标记的 RFC
GitHub 标记的 issue
RFC(已搁置)首页风格指南
关于如何为 Rust crate 编写文档的指南