Skip to content

Commit 5352fca

Browse files
committed
update what-is-rustdoc.md
1 parent f9dc23d commit 5352fca

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/what-is-rustdoc.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -20,32 +20,32 @@ $ cargo new docs --lib
2020
$ cd docs
2121
```
2222

23-
`src/lib.rs` 中,Cargo 生成了一些事例代码,删掉使用下面的代码代替
23+
`src/lib.rs` 中,Cargo 生成了一些示例代码,将其删除并替换为下面的代码:
2424

2525
```rust
2626
/// foo is a function
2727
fn foo() {}
2828
```
2929

30-
然后我们运行 `rustdoc`。我们可以在 crate 根目录执行下面的命令
30+
然后我们运行 `rustdoc`。我们可以在 crate 根路径执行下面的命令:
3131

3232
```bash
3333
$ rustdoc src/lib.rs
3434
```
3535

36-
这会创建一个新目录 `doc`其中是一个网站结构。在我们的例子中,主页面是 `doc/lib/index.html`。如果你使用浏览器打开,可以在 tab 栏看到 "Crate lib",页面没有内容。
36+
这会创建一个新目录 `doc`其中包含一个网站。在我们的例子中,主页面是 `doc/lib/index.html`。如果你使用浏览器打开,可以看到一个带有搜索栏的页面,在顶部可以看到“Crate lib,页面没有内容。
3737

3838
## 配置 rustdoc
3939

40-
现在有两个问题:第一,为什么我们的包名字是 "lib"?第二,为什么没有任何内容?
40+
现在有两个问题:第一,为什么我们的包名字是lib?第二,为什么没有任何内容?
4141

4242
第一个问题的原因是因为 `rustdoc` 试图更好用,像 `rustc` 就假定我们 crate 的名字就是 crate 根目录文件的名字。为了修复这个问题,可以通过命令行传递参数:
4343

4444
```bash
4545
$ rustdoc src/lib.rs --crate-name docs
4646
```
4747

48-
现在, `doc/docs/index.html` 文件生成,页面名称为 "Crate docs"
48+
现在,`doc/docs/index.html` 文件生成,页面名称为Crate docs
4949

5050
对于第二个问题,因为我们的函数 `foo` 不是公共的;`rustdoc` 默认只会为公共函数生成文档,如果我们将代码修改为
5151

@@ -54,13 +54,13 @@ $ rustdoc src/lib.rs --crate-name docs
5454
pub fn foo() {}
5555
```
5656

57-
然后重新运行 `rustdoc`:
57+
然后重新运行 `rustdoc`
5858

5959
```bash
6060
$ rustdoc src/lib.rs --crate-name docs
6161
```
6262

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
6464

6565
## 通过 Cargo 使用 rustdoc
6666

@@ -98,7 +98,7 @@ dependency=<path>/docs/target/debug/deps
9898

9999
## 利用单独的 Markdown 文件
100100

101-
`rustdoc` 可以为单独的 markdown 文件生成 HTML。让我们尝试一下,创建`README.md`,并输入如下内容
101+
`rustdoc` 可以为单独的 markdown 文件生成 HTML。让我们尝试一下,创建 `README.md`,并输入如下内容
102102

103103
````text
104104
# Docs

0 commit comments

Comments
 (0)