Rust Programming By Example

Headers

The doc-comments are written in Markdown, so let's look at some Markdown formatting syntax. We can write headers by starting a line with a #. The more #'s, the smaller the title.

For example:

/// Some introduction text.
///
/// # Big Title
///
/// ## Less big title
///
/// ### Even less big title.
///
/// #### Small title
///
/// ...

I think you get it at this point!

Here is a list of common headers:

• Examples
• Panics
• Failure