Skip to content

Commit e9b2fd1

Browse files
committed
Add notes
1 parent 7e39b4c commit e9b2fd1

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

src/what-is-rustdoc.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1-
# 什么是 rustdoc?
1+
# 什么是 rustdoc?
2+
3+
> 中文翻译注(The Chinese translation of [The rustdoc Book][website]):
4+
>
5+
> - 👉 查看更多 <a href="https://rustwiki.org/" style="color:#97ca00;font-weight:bold;">Rust 官方文档中英文双语教程</a>,包括双语版[《Rust 程序设计语言》][book-cn](出版书名为《Rust 权威指南》),本站还提供了 [Rust 标准库中文版][std-cn]
6+
> - 《rustdoc 手册》(*rustdoc Book* 中文版)翻译自 [*rustdoc Book*][website],内容已全部翻译完成,查看此书的 [Github 翻译项目和源码][github-src]
7+
> - 本文版最后更新时间:2022-02-04。
8+
> - 本文档已加入到 [Rust 中文翻译项目组][rust-lang-cn],主要译者:[*David*][david][Rust 中文翻译项目组][rust-lang-cn] 交流群成员。
9+
> - <a href="https://rustwiki.org/en/rustdoc/" style="color:red;">本站支持文档中英文切换</a>,点击页面右上角语言图标可切换到相同章节的英文页面,**英文版每天都会自动同步一次官方的最新版本**
10+
> - 若发现当前页表达错误或帮助我们改进翻译,可点击右上角的编辑按钮打开该页对应源码文件进行编辑和修改,Rust 中文资源的开源组织发展离不开大家,感谢您的支持和帮助!
211
312
标准 Rust 版本包含了名为 `rustdoc` 的工具。它的作用是为 Rust 项目生成文档,Rustdoc 接受一个 crate 根目录或者一个 markdown 文件作为参数,生成 HTML,CSS 和 Javascript 文件。
413

@@ -119,3 +128,10 @@ $ rustdoc README.md
119128
## 总结
120129

121130
本节涵盖了`rustdoc`的基本使用方法。本书的剩余部分会展示`rustdoc`所有的可选功能,以及如何使用它们。
131+
132+
[website]: https://doc.rust-lang.org/rustdoc/
133+
[book-cn]: https://rustwiki.org/zh-CN/book/
134+
[std-cn]: https://rustwiki.org/zh-CN/std/
135+
[github-src]: https://github.com/rust-lang-cn/rustdoc-cn
136+
[rust-lang-cn]: https://github.com/rust-lang-cn
137+
[david]: https://github.com/wendajiang

0 commit comments

Comments
 (0)