rust注释

一、普通注释

复制代码
// 这是第一种注释方式

/* 这是第二种注释方式 */
/*
多行注释
多行注释
多行注释
 */

二、文档注释

复制代码
///外部行文档注释。为接下来的项生成帮助文档
//! 内部行文档注释。为注释所属于的项生成帮助文档

/**...*/外部块文档注释。为接下来的项生成帮助文档
/*!...*/内部块文档注释。为注释所属于的项生成帮助文档

实例

复制代码
/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
    return a + b;
}
fn main() {
    println!("{}",add(2,3));
}

用 cargo doc 构建文档到 target/doc。注释转换成HTML格式的说明文档。

用 cargo test --doc 仅运行文档测试。

这些命令最终会调用 rustdoc。

三、文档属性

下面是一些最常使用的 #[doc] 属性

1.inline

用于内联文档,而不是链接到单独的页面。

例子

复制代码
#[doc(inline)]
pub use bar::Bar;
/// bar的文档
mod bar {
     /// Bar的文档
     pub struct Bar;
} 

2.no_inline

用于防止链接到单独的页面或其他位置。

例子

复制代码
#[doc(no_inline)]
pub use crate::mem::drop; 

3.hidden

使用此属性来告诉 rustdoc 不要包含此项到文档中:

例子

复制代码
#[doc(hidden)]
pub use self::async_await::*;
相关推荐
ServBay12 小时前
Rust 1.89更新,有哪些值得关注的新功能
后端·rust
MOON404☾14 小时前
Rust程序语言设计(5-8)
开发语言·后端·rust
Vallelonga1 天前
Rust 中的数组和数组切片引用
开发语言·rust
Kiri霧1 天前
Rust模式匹配详解
开发语言·windows·rust
mit6.8241 天前
理念导向编程|ts
rust·typescript
ZC·Shou2 天前
Rust 之二 各组件工具的源码、构建、配置、使用
rust·cargo·rustup·mdbook·clippy
MOON404☾2 天前
Rust 与 传统语言:现代系统编程的深度对比
开发语言·后端·python·rust
一只小松许️2 天前
深入理解:Rust 的内存模型
java·开发语言·rust
修仙的人2 天前
Rust + WebAssembly 实战!别再听说,学会使用!
前端·rust
alwaysrun3 天前
Rust中的特征Trait
rust·trait·impl trait·dyn trait·派生特征