Add a section about crate documentation.
This commit is contained in:
parent
8a50e295fa
commit
159d1ab540
@ -486,6 +486,17 @@ you have a module in `foo.rs`, you'll often open its code and see this:
|
||||
//! The `foo` module contains a lot of useful functionality blah blah blah
|
||||
```
|
||||
|
||||
### Crate documentation
|
||||
|
||||
Crates can be documented by placing an inner doc comment (`//!`) at the
|
||||
beginning of the crate root, aka `lib.rs`:
|
||||
|
||||
```rust
|
||||
//! This is documentation for the `foo` crate.
|
||||
//!
|
||||
//! The foo crate is meant to be used for bar.
|
||||
```
|
||||
|
||||
### Documentation comment style
|
||||
|
||||
Check out [RFC 505][rfc505] for full conventions around the style and format of
|
||||
|
Loading…
Reference in New Issue
Block a user