|
|
## Documentation testing
|
|
|
The primary way of documenting a Rust project is through annotating the source code. Documentation comments are written in markdown and support code blocks in them. Rust takes care about correctness, so these code blocks are compiled and used as tests.
|
|
|
|
|
|
```rust
|
|
|
/// First line is a short summary describing function.
|
|
|
///
|
|
|
/// The next lines present detailed documentation. Code blocks start with
|
|
|
/// triple backquotes and have implicit `fn main()` inside
|
|
|
/// and `extern crate <cratename>`. Assume we're testing `doccomments` crate:
|
|
|
///
|
|
|
/// ```
|
|
|
/// let result = doccomments::add(2, 3);
|
|
|
/// assert_eq!(result, 5);
|
|
|
/// ```
|
|
|
pub fn add(a: i32, b: i32) -> i32 {
|
|
|
a + b
|
|
|
}
|
|
|
|
|
|
/// Usually doc comments may include sections "Examples", "Panics" and "Failures".
|
|
|
///
|
|
|
/// The next function divides two numbers.
|
|
|
///
|
|
|
/// # Examples
|
|
|
///
|
|
|
/// ```
|
|
|
/// let result = doccomments::div(10, 2);
|
|
|
/// assert_eq!(result, 5);
|
|
|
/// ```
|
|
|
///
|
|
|
/// # Panics
|
|
|
///
|
|
|
/// The function panics if the second argument is zero.
|
|
|
///
|
|
|
/// ```rust,should_panic
|
|
|
/// // panics on division by zero
|
|
|
/// doccomments::div(10, 0);
|
|
|
/// ```
|
|
|
pub fn div(a: i32, b: i32) -> i32 {
|
|
|
if b == 0 {
|
|
|
panic!("Divide-by-zero error");
|
|
|
}
|
|
|
|
|
|
a / b
|
|
|
}
|
|
|
|
|
|
/// Using hidden `try_main` in doc tests.
|
|
|
///
|
|
|
/// ```
|
|
|
/// # // hidden lines start with `#` symbol, but they're still compileable!
|
|
|
/// # fn try_main() -> Result<(), String> { // line that wraps the body shown in doc
|
|
|
/// let res = try::try_div(10, 2)?;
|
|
|
/// # Ok(()) // returning from try_main
|
|
|
/// # }
|
|
|
/// # fn main() { // starting main that'll unwrap()
|
|
|
/// # try_main().unwrap(); // calling try_main and unwrapping
|
|
|
/// # // so that test will panic in case of error
|
|
|
/// # }
|
|
|
/// ```
|
|
|
pub fn try_div(a: i32, b: i32) -> Result<i32, String> {
|
|
|
if b == 0 {
|
|
|
Err(String::from("Divide-by-zero"))
|
|
|
} else {
|
|
|
Ok(a / b)
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
```bash
|
|
|
$ cargo test
|
|
|
running 0 tests
|
|
|
|
|
|
test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
|
|
|
|
|
|
Doc-tests doccomments
|
|
|
|
|
|
running 3 tests
|
|
|
test src/lib.rs - add (line 7) ... ok
|
|
|
test src/lib.rs - div (line 21) ... ok
|
|
|
test src/lib.rs - div (line 31) ... ok
|
|
|
|
|
|
test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
|
|
|
```
|
|
|
|
|
|
## 最新进展
|
|
|
根据twitter上的消息，rust即将支持从测试文件中，自动获取文档注释的功能，这样就能保持测试文件和文档的一致性，无需在多个地方维护多套测试代码 |
