1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-06-24 09:46:45 +02:00

Add a brief mention of doc comments (#509)

This commit is contained in:
Dustin J. Mitchell
2023-03-21 12:15:07 -04:00
committed by GitHub
parent 365795f9cd
commit 3b538b582d
3 changed files with 48 additions and 0 deletions

View File

@ -21,6 +21,20 @@ The `crate` root is in:
* `src/lib.rs` (for a library crate)
* `src/main.rs` (for a binary crate)
Modules defined in files can be documented, too, using "inner doc comments".
These document the item that contains them -- in this case, a module.
```rust,editable,compile_fail
//! This module implements the garden, including a highly performant germination
//! implementation.
/// Sow the given seed packets.
fn sow(seeds: Vec<SeedPacket>) { todo!() }
// Harvest the produce in the garden that is ready.
fn harvest(garden: &mut Garden) { todo!() }
```
<details>
* The change from `module/mod.rs` to `module.rs` doesn't preclude the use of submodules in Rust 2018.