当前位置: 首页 > 文档资料 > 通过例子学 Rust >

补充 - 文档

优质
小牛编辑
128浏览
2023-12-01

文档注释对于需要文档的大型项目来说非常重要。当运行 Rustdoc,这些注释就会编译成文档。它们使用 /// 标记,并支持 Markdown

  1. #![crate_name = "doc"]
  2. /// 这里给出一个人类
  3. pub struct Person {
  4. /// 一个人必须有名字,不管 Juliet 多讨厌他/她。
  5. name: String,
  6. }
  7. impl Person {
  8. /// 返回给定名字的人
  9. ///
  10. /// # 参数
  11. ///
  12. /// * `name` - 字符串 slice,代表人物的名称
  13. ///
  14. /// # 示例:
  15. ///
  16. ///
  1. /// // 可以在注释的特定标记内编写 Rust。
  2. /// // 如果可以通过 --- 测试传递给 Rustdoc,它将会帮你进行测试!
  3. /// let person = Person::new("name);
  4. /// ```
  5. pub fn new(name: &str) -> Person {
  6. Person {
  7. name: name.to_string(),
  8. }
  9. }
  10. /// 给一个友好的问候!
  11. /// 对被叫到的 `Person` 说 "Hello, [name]" 。
  12. pub fn hello(& self) {
  13. println!("Hello, {}!", self.name);
  14. }

}

fn main() {
let john = Person::new(“John”);

  1. john.hello();

}

  1. 要运行测试,首先将代码构建为库,然后告诉 `rustdoc` 在哪里找到库,以便它可以将代码链接成各个文档测试程序:
  2. ```bash
  3. $ rustc doc.rs --crate-type lib
  4. $ rustdoc --test --extern doc="libdoc.rs"

(当你在库 crate 上运行 cargo test 时,Cargo 将自动生成并运行正确的 rustcrustdoc 命令。)