Rust 注释
阐述
注释分为代码注释和文档注释两类。
代码注 释
分为行注释 // 和块注释 /* */。
文档注释
文档行注释
文档行注释需要位于 lib 类型的包中，被注释的对象需要使用 pub 对外可见。
文档块注释
与行注释差不多，但是换成 /** ... */，这样在较长的注释时可以减少 /// 的使用。
包和模块注释
包和模块的注释需要写到最上方。也分为行注释 //! 和块注释 /*! ... */。
注释标题
- Examples：示例
- Panics：可能会出现的异常状况
- Errors：可能会出现的错误
- Safety：使用
unsafe代码时需要注意的事情
文档测试
注释可以作为测试用例来运行。
链接跳转
- 跳转到标准库：[
Option] - 跳转到自己代码或者其他库的项：[
crate::X]
实例
/// `add_one` 将指定值加1
///
/// # Examples
///
/// ```
/// let arg = 5;
/// let answer = my_crate::add_one(arg);
///
/// assert_eq!(6, answer);
/// ```
pub fn add_one(x: i32) -> i32 {
x + 1
}
/// `add_one` 将指定值加1
///
/// # Examples11
///
/// ```
/// let arg = 5;
/// let answer = world_hello::compute::add_one(arg);
///
/// assert_eq!(6, answer);
/// ```
pub fn add_one(x: i32) -> i32 {
x + 1
}