mirror of
https://github.com/rust-lang-cn/book-cn.git
synced 2025-02-02 15:28:40 +08:00
Update ch14-02-publishing-to-crates-io.md
This commit is contained in:
parent
81f4c04c0d
commit
4263f2af56
@ -65,7 +65,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 所示:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user