文档

文档是任何软件项目中重要的一部分，并且它在Rust中是一级重要的。让我们讨论下Rust提供给我们编写项目文档的的工具。

rustdoc

Rust发行版中包含了一个工具，rustdoc，它可以生成文档。rustdoc也可以在Cargo中通过cargo doc使用。

文档可以使用两种方法生成：从源代码，或者从单独的Markdown文件。

注释

Rust 代码文件中，通常我们可以看到 3 种注释。

  • 行注释
  • 文档注释
  • 模块注释

行注释

// 后的，直到行尾，都属于注释，不会影响程序的行为。

  1. // 创建一个绑定
  2. let x = 5;
  4. let y = 6; // 创建另一个绑定

文档注释

文档注释使用 ///，一般用于函数或结构体（字段）的说明，置于要说明的对象上方。文档注释内部可使用markdown格式的标记语法，可用于 rustdoc 工具的自动文档提取。

  1. /// Adds one to the number given.
  2. ///
  3. /// # Examples
  4. ///
  5. /// ```
  6. /// let five = 5;
  7. ///
  8. /// assert_eq!(6, add_one(5));
  9. /// # fn add_one(x: i32) -> i32 {
  10. /// #     x + 1
  11. /// # }
  12. /// ```
  13. fn add_one(x: i32) -> i32 {
  14.     x + 1
  15. }

模块注释

模块注释使用 //!，用于说明本模块的功能。一般置于模块文件的头部。

  1. //! # The Rust Standard Library
  2. //!
  3. //! The Rust Standard Library provides the essential runtime
  4. //! functionality for building portable Rust software.

PS: 相对于 ///, //! 用来注释包含它的项（也就是说，crate，模块或者函数），而不是位于它之后的项。

其它：兼容C语言的注释

Rust 也支持兼容 C 的块注释写法：/* */。但是不推荐使用，请尽量不要使用这种注释风格（会被鄙视的）。

  1. /*
  2.     let x = 42;
  3.     println!("{}", x);
  4. */

文档化源代码

文档化Rust项目的主要方法是在源代码中添加注释。为了这个目标你可以这样使用文档注释：

  1. /// Constructs a new `Rc<T>`.
  2. ///
  3. /// # Examples
  4. ///
  5. /// ```
  6. /// use std::rc::Rc;
  7. ///
  8. /// let five = Rc::new(5);
  9. /// ```
  10. pub fn new(value: T) -> Rc<T> {
  11.     // implementation goes here
  12. }

这段代码产生像这样的文档。我忽略了函数的实现，而是留下了一个标准的注释。

第一个需要注意的地方是这个注释：它使用了///，而不是//。三斜线指示这是文档注释。

文档注释用Markdown语法编写。

Rust会记录这些注释，并在生成文档时使用它们。这在文档化像枚举这样的结构时很重要：

  1. /// The `Option` type. See [the module level documentation](../) for more.
  2. enum Option<T> {
  3.     /// No value
  4.     None,
  5.     /// Some value `T`
  6.     Some(T),
  7. }

上面的代码可以工作，但这个不行：

  1. /// The `Option` type. See [the module level documentation](../) for more.
  2. enum Option<T> {
  3.     None, /// No value
  4.     Some(T), /// Some value `T`
  5. }

你会得到一个错误：

  1. hello.rs:4:1: 4:2 error: expected ident, found `}`
  2. hello.rs:4 }
  3.            ^

这个不幸的错误是有道理的：文档注释适用于它后面的内容，而在在最后的注释后面没有任何内容。

编写文档注释

不管怎样，让我们来详细了解一下注释的每一部分：

  1. /// Constructs a new `Rc<T>`.
  2. # fn foo() {}

文档注释的第一行应该是它功能的一个简要总结。一句话。只包括基础。高层次。

  1. ///
  2. /// Other details about constructing `Rc<T>`s, maybe describing complicated
  3. /// semantics, maybe additional options, all kinds of stuff.
  4. ///
  5. # fn foo() {}

我们原始的例子只有一行总结，不过如果有更多东西要写，我们在一个新的段落增加更多解释。

特殊部分

下面，是特殊部分。它由一个标头指示，#。有四种经常使用的标头。它们不是特殊的语法，只是传统，目前为止。

  1. /// # Panics
  2. # fn foo() {}

不可恢复的函数滥用（比如，程序错误）在Rust中通常用恐慌（panics）指示，它至少会杀死整个当前的线程。如果你的函数有被识别为或者强制为恐慌这样的不平凡契约，记录文档是非常重要的。

  1. /// # Failures
  2. # fn foo() {}

如果你的函数或方法返回Result<T, E>，那么描述何种情况下它会返回Err(E)是件好事。这并不如Panics重要，因为失败（failure）被编码进了类型系统，不过仍旧是件好事。

  1. /// # Safety
  2. # fn foo() {}

如果你的函是unsafe的，你应该解释调用者应该支持哪种不可变量。

  1. /// # Examples
  2. ///
  3. /// ```
  4. /// use std::rc::Rc;
  5. ///
  6. /// let five = Rc::new(5);
  7. /// ```
  8. # fn foo() {}

第四个，Examples。包含一个或多个使用你函数的例子，这样你的用户会为此感（ài）谢（shàng）你的。这些例子写在代码块注释中，我们稍后会讨论到，并且可以有不止一个部分：

  1. /// # Examples
  2. ///
  3. /// Simple `&str` patterns:
  4. ///
  5. /// ```
  6. /// let v: Vec<&str> = "Mary had a little lamb".split(' ').collect();
  7. /// assert_eq!(v, vec!["Mary", "had", "a", "little", "lamb"]);
  8. /// ```
  9. ///
  10. /// More complex patterns with a lambda:
  11. ///
  12. /// ```
  13. /// let v: Vec<&str> = "abc1def2ghi".split(|c: char| c.is_numeric()).collect();
  14. /// assert_eq!(v, vec!["abc", "def", "ghi"]);
  15. /// ```
  16. # fn foo() {}

让我们聊聊这些代码块的细节。

代码块注释

在注释中编写Rust代码，使用三个重音号：

  1. /// ```
  2. /// println!("Hello, world");
  3. /// ```
  4. # fn foo() {}

如果你想要一些不是Rust的代码，你可以加上一个注解：

  1. /// ```c
  2. /// printf("Hello, world\n");
  3. /// ```
  4. # fn foo() {}

这会根据你选择的语言高亮代码。如果你只是想展示普通文本，选择text。

选择正确的注释是很重要的，因为rustdoc用一种有意思的方法使用它：它可以用来实际测试你的代码，这样你的注解就不会过时。如果你写了些C代码不过rustdoc会认为它是Rust代码由于你忽略了注解，rustdoc会在你生成文档时提示。

文档作为测试

让我们看看我的例子文档的样例：

  1. /// ```
  2. /// println!("Hello, world");
  3. /// ```
  4. # fn foo() {}

你会注意到你并不需要fn main()或者别的什么函数。rustdoc会自动一个main()包装你的代码，使用试探法试图把它放到正确的位置。例如：

  1. /// ```
  2. /// use std::rc::Rc;
  3. ///
  4. /// let five = Rc::new(5);
  5. /// ```
  6. # fn foo() {}

这会作为测试：

  1. fn main() {
  2.     use std::rc::Rc;
  3.     let five = Rc::new(5);
  4. }

这里是rustdoc用来后处理例子的完整的算法：

  1. 任何#![foo]开头的属性会被完整的作为包装箱属性
  2. 一些通用的allow属性被插入，包括unused_variables、unused_assignments、unused_mut、unused_attributes和dead_code。小的例子经常触发这些lint检查
  3. 如果例子并未包含extern crate，那么extern crate <mycrate>;被插入（注意缺失了#[macro_use]）
  4. 最后，如果例子不包含fn main，剩下的文本将被包装到fn main() { your_code }中

有时，这是不够的。例如，我们已经考虑到了所有///开头的代码样例了吗？普通文本：

  1. /// Some documentation.
  2. # fn foo() {}

与它的输出看起来有些不同：

  1. /// Some documentation.
  2. # fn foo() {}

是的，你猜对了：你写的以#开头的行会在输出中被隐藏，不过会在编译你的代码时被使用。你可以利用这一点。在这个例子中，文档注释需要适用于一些函数，所以我只想向你展示文档注释，我需要在下面增加一些函数定义。同时，这只是用来满足编译器的，所以省略它会使得例子看起来更清楚。你可以使用这个技巧来详细的解释较长的例子，同时保留你文档的可测试行。

例如，想象一下我们想要为如下代码写文档：

  1. let x = 5;
  2. let y = 6;
  3. println!("{}", x + y);

最终我们可能想要文档变成这样：

首先，我们把x设置为5：

  1. let x = 5;
  2. # let y = 6;
  3. # println!("{}", x + y);

接着，我们把y设置为6：

  1. # let x = 5;
  2. let y = 6;
  3. # println!("{}", x + y);

最后，我们打印x和y的和：

  1. # let x = 5;
  2. # let y = 6;
  3. println!("{}", x + y);

为了让每个代码块可以执行，我们想要每个代码块都有整个程序，不过我们并不想读者每回都看到所有的行。这是我们的源代码：

  1.     首先，我们把`x`设置为`5`：
  3.     ```text
  4.     let x = 5;
  5.     # let y = 6;
  6.     # println!("{}", x + y);
  7.     ```
  9.     接着，我们把`y`设置为`6`：
  11.     ```text
  12.     # let x = 5;
  13.     let y = 6;
  14.     # println!("{}", x + y);
  15.     ```
  17.     最后，我们打印`x`和`y`的和：
  19.     ```text
  20.     # let x = 5;
  21.     # let y = 6;
  22.     println!("{}", x + y);
  23.     ```

通过重复例子的所有部分，你可以确保你的例子仍能编译，同时只显示与你解释相关的部分。

文档化宏

下面是一个宏的文档例子：

  1. /// Panic with a given message unless an expression evaluates to true.
  2. ///
  3. /// # Examples
  4. ///
  5. /// ```
  6. /// # #[macro_use] extern crate foo;
  7. /// # fn main() {
  8. /// panic_unless!(1 + 1 == 2, “Math is broken.”);
  9. /// # }
  10. /// ```
  11. ///
  12. /// ```should_panic
  13. /// # #[macro_use] extern crate foo;
  14. /// # fn main() {
  15. /// panic_unless!(true == false, “I’m broken.”);
  16. /// # }
  17. /// ```
  18. #[macro_export]
  19. macro_rules! panic_unless {
  20.     ($condition:expr, $($rest:expr),+) => ({ if ! $condition { panic!($($rest),+); } });
  21. }
  22. # fn main() {}

你会注意到3个地方：我们需要添加我们自己的extern crate行，这样我们可以添加#[macro_use]属性。第二，我们也需要添加我们自己的main()（为了上面讨论过的原因）。最后，用#机智的注释掉这两个代码，这样它们不会出现在输出中。

另一个#好用的情况是当你想要忽略错误处理的时候。例如你想要如下情况。

  1. /// use std::io;
  2. /// let mut input = String::new();
  3. /// try!(io::stdin().read_line(&mut input));

问题是try!返回一个Result<T, E>而测试函数并不返回任何值所以这会产生一个类型不匹配错误。

  1. /// A doc test using try!
  2. ///
  3. /// ```
  4. /// use std::io;
  5. /// # fn foo() -> io::Result<()> {
  6. /// let mut input = String::new();
  7. /// try!(io::stdin().read_line(&mut input));
  8. /// # Ok(())
  9. /// # }
  10. /// ```
  11. # fn foo() {}

你可以将代码放进函数里来解决这个问题。在运行文档测试时它捕获并返回Result<T, E>。这种模式不时出现在标准库中。

运行文档测试

要运行测试，要么

  1. $ rustdoc --test path/to/my/crate/root.rs
  2. # or（或者）
  3. $ cargo test

对了，cargo test也会测试内嵌的文档。然而，cargo test将不会测试二进制 crate，只测试库 crate。这是由于rustdoc的运行机制：它链接要测试的库，不过对于一个二进制文件，木有什么好链接的。

这还有一些注释有利于帮助rustdoc在测试你的代码时正常工作：

  1. /// ```ignore
  2. /// fn foo() {
  3. /// ```
  4. # fn foo() {}

ignore指令告诉Rust忽略你的代码。这几乎不会是你想要的，因为这是最不受支持的。相反，如果不是代码的话考虑注释为text，或者使用#来形成一个可运行但只显示你关心部分的例子。

  1. /// ```should_panic
  2. /// assert!(false);
  3. /// ```
  4. # fn foo() {}

should_panic告诉rustdoc这段代码应该正确编译，但是作为一个测试则不能通过。

  1. /// ```no_run
  2. /// loop {
  3. ///     println!("Hello, world");
  4. /// }
  5. /// ```
  6. # fn foo() {}

no_run属性会编译你的代码，但是不运行它。这对像如“如何开始一个网络服务”这样的例子很重要，你会希望确保它能够编译，不过它可能会无限循环的执行！

文档化模块

Rust有另一种文档注释，//!。这种注释并不文档化接下来的内容，而是包围它的内容。换句话说：

  1. mod foo {
  2.     //! This is documentation for the `foo` module.
  3.     //!
  4.     //! # Examples
  6.     // ...
  7. }

这是你会看到//!最常见的用法：作为模块文档。如果你在foo.rs中有一个模块，打开它你常常会看到这些：

  1. //! A module for using `foo`s.
  2. //!
  3. //! The `foo` module contains a lot of useful functionality blah blah blah

文档注释风格

查看RFC 505以了解文档风格和格式的惯例。

其它文档

所有这些行为都能在非 Rust 代码文件中工作。因为注释是用 Markdown 编写的，它们通常是.md文件。

当你在 Markdown 文件中写文档时，你并不需要加上注释前缀。例如：

  1. /// # Examples
  2. ///
  3. /// ```
  4. /// use std::rc::Rc;
  5. ///
  6. /// let five = Rc::new(5);
  7. /// ```
  8. # fn foo() {}

在一个Markdown文件中，就是：

  1. # Examples
  3. ```
  4. use std::rc::Rc;
  6. let five = Rc::new(5);
  7. ```

不过文档写在 Markdown 文件中要加一点：Markdown文件需要有一个像这样的标题：

  1. % The title
  3. This is the example documentation.

%行需要放在文件的第一行。

doc属性

在更底层，文档注释是文档属性的语法糖：

  1. /// this
  2. # fn foo() {}
  4. #[doc="this"]
  5. # fn bar() {}

跟下面这个是相同的：

  1. //! this
  3. #![doc="this"]

写文档时你不会经常看见这些属性，不过当你要改变一些选项，或者写一个宏的时候比较有用。

重导出（Re-exports）

rustdoc对公有重导出部分会在两个地方都显式文档：

  1. extern crate foo;
  3. pub use foo::bar;

这既会为bar在foo包装箱中生成文档，也会在你的包装箱中生成文档。它会在两个地方使用相同的内容。

这种行文可以通过no_inline来阻止：

  1. extern crate foo;
  3. #[doc(no_inline)]
  4. pub use foo::bar;

缺失文档

有时你想要确保你项目中每一个公开的项都有文档，特别是当你编写一个库的时候。Rust 允许你为此产生警告或错误，当一个项缺少文档时。为了生成警告，你需要使用warn：

  1. #![warn(missing_docs)]

而为了生成错误你需要使用deny：

  1. #![deny(missing_docs)]

有时你想要显式的禁用警告/错误来让一些项没有文档。这可以使用allow来搞定：

  1. #[allow(missing_docs)]
  2. struct Undocumented;

你可能甚至希望在文档中完全隐藏某些项：

  1. #[doc(hidden)]
  2. struct Hidden;

控制HTML

你可以通过#![doc]属性控制rustdoc生成的THML文档的一些方面：

  1. #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  2.        html_favicon_url = "https://www.rust-lang.org/favicon.ico",
  3.        html_root_url = "https://doc.rust-lang.org/")]

这里设置了一些不同的选项，带有一个logo，一个网站图标，和一个根URL。

配置文档测试

你也可以通过#![doc(test(..))]属性来配置rustdoc测试你文档示例的方式。

  1. #![doc(test(attr(allow(unused_variables), deny(warnings))))]

这允许示例中存在未使用的变量，但其他 lint 警告抛出仍会使测试失败。

生成选项

rustdoc也提供了一些其他命令行选项，以便进一步定制：

  • --html-in-header FILE：在<head>...</head>部分的末尾加上FILE内容
  • --html-before-content FILE：在<body>之后，在渲染内容之前加上FILE内容
  • --html-after-content FILE：在所有渲染内容之后加上FILE内容

注解安全

文档注释中的Markdown会被不加处理的放置于最终的网页中。注意HTML文本（XSS？）：

  1. /// <script>alert(document.cookie)</script>
  2. # fn foo() {}