المستندات التوثيقية (Documentation)
Rust comes with extensive documentation. For example:
- All of the details about loops.
- Primitive types like
u8. - Standard library types like
OptionorBinaryHeap.
In fact, you can document your own code:
The contents are treated as Markdown. All published Rust library crates are automatically documented at docs.rs using the rustdoc tool. It is idiomatic to document all public items in an API using this pattern.
To document an item from inside the item (such as inside a module), use //! or /*! .. */, called “inner doc comments”:
Speaker Notes
This slide should take about 5 minutes.
- Show students the generated docs for the
randcrate at https://docs.rs/rand.