You've already forked comprehensive-rust
mirror of
https://github.com/google/comprehensive-rust.git
synced 2025-06-15 13:50:27 +02:00
Add a brief mention of doc comments (#509)
This commit is contained in:
committed by
GitHub
parent
365795f9cd
commit
3b538b582d
33
src/basic-syntax/rustdoc.md
Normal file
33
src/basic-syntax/rustdoc.md
Normal file
@ -0,0 +1,33 @@
|
||||
# Rustdoc
|
||||
|
||||
All language items in Rust can be documented using special `///` syntax.
|
||||
|
||||
```rust,editable
|
||||
/// Determine whether the first argument is divisible by the second argument.
|
||||
///
|
||||
/// If the second argument is zero, the result is false.
|
||||
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
|
||||
if rhs == 0 {
|
||||
return false; // Corner case, early return
|
||||
}
|
||||
lhs % rhs == 0 // The last expression in a block is the return value
|
||||
}
|
||||
```
|
||||
|
||||
The contents are treated as Markdown. All published Rust library crates are
|
||||
automatically documented at [`docs.rs`](https://docs.rs) using the
|
||||
[rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) tool. It is
|
||||
idiomatic to document all public items in an API using this pattern.
|
||||
|
||||
<details>
|
||||
|
||||
* Show students the generated docs for the `rand` crate at
|
||||
[`docs.rs/rand`](https://docs.rs/rand).
|
||||
|
||||
* This course does not include rustdoc on slides, just to save space, but in
|
||||
real code they should be present.
|
||||
|
||||
* Inner doc comments are discussed later (in the page on modules) and need not
|
||||
be addressed here.
|
||||
|
||||
</details>
|
Reference in New Issue
Block a user