Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
int
Rust
提交
fd5859a6
R
Rust
项目概览
int
/
Rust
接近 1 年 前同步成功
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
R
Rust
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
fd5859a6
编写于
9月 03, 2020
作者:
A
arijit79
提交者:
Mark Rousskov
9月 10, 2020
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Add docs about crate level documentation support
上级
3f5e617e
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
23 addition
and
0 deletion
+23
-0
src/doc/rustdoc/src/what-is-rustdoc.md
src/doc/rustdoc/src/what-is-rustdoc.md
+23
-0
未找到文件。
src/doc/rustdoc/src/what-is-rustdoc.md
浏览文件 @
fd5859a6
...
...
@@ -93,6 +93,29 @@ passes `-L`, a flag that helps rustdoc find the dependencies
your code relies on. If our project used dependencies, we'd get
documentation for them as well!
## Outer and inner documentation
The
`///`
syntax is used to document the item present after it.
That's why it is called an outer documentation.
There is another syntax:
`//!`
, which is used to document the
item it is present inside. It is called an inner documentation.
It is often used when documenting the entire crate,
because nothing comes before it: it is the root of the crate.
So in order to document an entire crate, you need to use
`//!`
syntax.
For example:
```
rust
//! This is my first rust crate
```
When used in the crate root, it documents the item it is inside,
which is the crate itself.
For more information about the
`//!`
syntax, see [the Book].
[
the Book
]:
https://doc.rust-lang.org/book/ch14-02-publishing-to-crates-io.html#commenting-contained-items
## Using standalone Markdown files
`rustdoc`
can also generate HTML from standalone Markdown files. Let's
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录