Documentación
Rust incluye una amplia documentación. Por ejemplo:
- Todos los detalles sobre bucles.
- Tipos primitivos como
u8
. - Tipos de la biblioteca estándar como
Option
oBinaryHeap
.
De hecho, puedes documentar tu propio código:
El contenido se trata como Markdown. Todos los crates de la biblioteca de Rust publicados se documentan automáticamente en docs.rs
mediante la herramienta rustdoc. Es propio documentar todos los elementos públicos de una API usando este patrón.
Para documentar un elemento desde dentro (por ejemplo, dentro de un módulo), utiliza //!
o /*! .. */
, denominado como “comentarios internos del documento”:
Speaker Notes
This slide should take about 5 minutes.
- Muestra a los alumnos los documentos generados para el crate
rand
en https://docs.rs/rand.