Merge pull request #436 from Nangos/patch-26

Update ch14-02-publishing-to-crates-io.md
This commit is contained in:
KaiserY 2020-07-12 22:19:20 +08:00 committed by GitHub
commit aff3b0196d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -53,7 +53,7 @@ pub fn add_one(x: i32) -> i32 {
#### 文档注释作为测试
在文档注释中增加示例代码块是一个清楚的表明如何使用库的方法,这么做还有一个额外的好处:`cargo test` 也会像测试那样运行文档中的示例代码!没有什么比有例子的文档更好的了!也没有什么比不能正常工作的例子更糟的了,因为代码在编写文档时已经改变。尝试 `cargo test` 运行像示例 14-1 中 `add_one` 函数的文档;应该在测试结果中看到像这样的部分:
在文档注释中增加示例代码块是一个清楚的表明如何使用库的方法,这么做还有一个额外的好处:`cargo test` 也会像测试那样运行文档中的示例代码!没有什么比有例子的文档更好的了,但最糟糕的莫过于写完文档后改动了代码,而导致例子不能正常工作。尝试 `cargo test` 运行像示例 14-1 中 `add_one` 函数的文档;应该在测试结果中看到像这样的部分:
```text
Doc-tests my_crate
@ -68,7 +68,7 @@ test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
#### 注释包含项的结构
还有另一种风格的文档注释,`//!`,这为包含注释的项,而不是注释之后的项增加文档。这通常用于 crate 根文件(通常是 _src/lib.rs_)或模块的根文件为 crate 或模块整体提供文档。
还有另一种风格的文档注释,`//!`,这为包含注释的项,而不是位于注释之后的项增加文档。这通常用于 crate 根文件(通常是 _src/lib.rs_)或模块的根文件为 crate 或模块整体提供文档。
作为一个例子,如果我们希望增加描述包含 `add_one` 函数的 `my_crate` crate 目的的文档,可以在 _src/lib.rs_ 开头增加以 `//!` 开头的注释,如示例 14-2 所示:
@ -243,7 +243,7 @@ $ cargo login abcdefghijklmnopqrstuvwxyz012345
name = "guessing_game"
```
即使你选择了一个唯一的名称,如果此时尝试运行 `cargo publish` 发布该 crate 的话,会得到一个一个警告接着是一个错误:
即使你选择了一个唯一的名称,如果此时尝试运行 `cargo publish` 发布该 crate 的话,会得到一个警告接着是一个错误:
```text
$ cargo publish