Rust注释
简介
Rust 里的注释和C语言中的一样,分成两种:
- 行注释: 以
//
开头的一行,直到行结束符的一行所有内容。
|
|
- 块注释:
/*
和*/
中间的部分,支持换行;
|
|
注释文档
在上述基础注释功能上,Rust注释还带文档功能,且支持Markdown格式。文档注释也包含两种:
//!
用来描述包含它的项,一般用在模块文件的头部。///
用来描述的它后面接着的项。
比如在 main.rs 文件中输入以下内容:
|
|
可通过如下命令从注释中生成文档:
|
|
Rust 里的注释和C语言中的一样,分成两种:
//
开头的一行,直到行结束符的一行所有内容。
|
|
/*
和*/
中间的部分,支持换行;
|
|
在上述基础注释功能上,Rust注释还带文档功能,且支持Markdown格式。文档注释也包含两种:
//!
用来描述包含它的项,一般用在模块文件的头部。///
用来描述的它后面接着的项。比如在 main.rs 文件中输入以下内容:
|
|
可通过如下命令从注释中生成文档:
|
|
#{description}
#{ end }#{content}