File tree 1 file changed +8
-8
lines changed
1 file changed +8
-8
lines changed Original file line number Diff line number Diff line change @@ -20,32 +20,32 @@ $ cargo new docs --lib
20
20
$ cd docs
21
21
```
22
22
23
- 在 ` src/lib.rs ` 中,Cargo 生成了一些事例代码,删掉使用下面的代码代替
23
+ 在 ` src/lib.rs ` 中,Cargo 生成了一些示例代码,将其删除并替换为下面的代码:
24
24
25
25
``` rust
26
26
/// foo is a function
27
27
fn foo () {}
28
28
```
29
29
30
- 然后我们运行 ` rustdoc ` 。我们可以在 crate 根目录执行下面的命令
30
+ 然后我们运行 ` rustdoc ` 。我们可以在 crate 根路径执行下面的命令:
31
31
32
32
``` bash
33
33
$ rustdoc src/lib.rs
34
34
```
35
35
36
- 这会创建一个新目录 ` doc ` ,其中是一个网站结构 。在我们的例子中,主页面是 ` doc/lib/index.html ` 。如果你使用浏览器打开,可以在 tab 栏看到 " Crate lib" ,页面没有内容。
36
+ 这会创建一个新目录 ` doc ` ,其中包含一个网站 。在我们的例子中,主页面是 ` doc/lib/index.html ` 。如果你使用浏览器打开,可以看到一个带有搜索栏的页面,在顶部可以看到“ Crate lib” ,页面没有内容。
37
37
38
38
## 配置 rustdoc
39
39
40
- 现在有两个问题:第一,为什么我们的包名字是 " lib" ?第二,为什么没有任何内容?
40
+ 现在有两个问题:第一,为什么我们的包名字是“ lib” ?第二,为什么没有任何内容?
41
41
42
42
第一个问题的原因是因为 ` rustdoc ` 试图更好用,像 ` rustc ` 就假定我们 crate 的名字就是 crate 根目录文件的名字。为了修复这个问题,可以通过命令行传递参数:
43
43
44
44
``` bash
45
45
$ rustdoc src/lib.rs --crate-name docs
46
46
```
47
47
48
- 现在, ` doc/docs/index.html ` 文件生成,页面名称为 " Crate docs" 。
48
+ 现在,` doc/docs/index.html ` 文件生成,页面名称为“ Crate docs” 。
49
49
50
50
对于第二个问题,因为我们的函数 ` foo ` 不是公共的;` rustdoc ` 默认只会为公共函数生成文档,如果我们将代码修改为
51
51
@@ -54,13 +54,13 @@ $ rustdoc src/lib.rs --crate-name docs
54
54
pub fn foo () {}
55
55
```
56
56
57
- 然后重新运行 ` rustdoc ` :
57
+ 然后重新运行 ` rustdoc ` :
58
58
59
59
``` bash
60
60
$ rustdoc src/lib.rs --crate-name docs
61
61
```
62
62
63
- 现在我们生成了文档,打开 ` doc/docs/index.html ` ,显示了 ` foo ` 函数的连接页面,文件位置是 ` doc/docs/fn.foo.html ` 。在函数的页面上,你可以看到我们写的注释 " foo is a function" 。
63
+ 现在我们生成了文档,打开 ` doc/docs/index.html ` ,显示了 ` foo ` 函数的连接页面,文件位置是 ` doc/docs/fn.foo.html ` 。在函数的页面上,你可以看到我们写的注释“ foo is a function” 。
64
64
65
65
## 通过 Cargo 使用 rustdoc
66
66
@@ -98,7 +98,7 @@ dependency=<path>/docs/target/debug/deps
98
98
99
99
## 利用单独的 Markdown 文件
100
100
101
- ` rustdoc ` 可以为单独的 markdown 文件生成 HTML。让我们尝试一下,创建` README.md ` ,并输入如下内容
101
+ ` rustdoc ` 可以为单独的 markdown 文件生成 HTML。让我们尝试一下,创建 ` README.md ` ,并输入如下内容:
102
102
103
103
```` text
104
104
# Docs
You can’t perform that action at this time.
0 commit comments