Rust Programming Cookbook

How to do it...

Compile your code comments to a shiny HTML in just a few steps:

1. Rust's docstrings (strings that explicitly are documentation to be rendered) are denoted by /// (instead of the regular //). Within these sections, markdown—a shorthand language for HTML—can be used to create full documentation. Let's add the following before the List<T> declaration:

/// /// A singly-linked list, with nodes allocated on the heap using ///`Rc`s and `RefCell`s. Here's an image illustrating a linked list:/// /// /// ![](https://upload.wikimedia.org/wikipedia/commons/6/6d/Singly-///linked-list.svg)/// /// *Found on https://en.wikipedia.org/wiki/Linked_list*/// /// # Usage/// /// ```/// let list = List::new_empty();/// ```/// #[derive(Clone)]pub ...