Skip to content

Glossary: Rust in Practice

doc comment

Also written: doc comments, ///, //!

A `///` comment documents the item after it and a `//!` comment documents the crate. Tools turn them into `--help` text (clap) or into the pages on docs.rs.

Where the book teaches it

Related terms

doc testcargo doc