Documentação
O Rust vem com uma extensa documentação. Por exemplo:
- Todos os detalhes sobre loops.
- Tipos primitivos como
u8. - Tipos da biblioteca padrão como
OptionouBinaryHeap.
Na verdade, você pode documentar seu próprio código:
O conteúdo é tratado como Markdown. Todos os crates publicados na biblioteca Rust são documentados automaticamente em docs.rs utilizando a ferramenta rustdoc. É idiomático documentar todos os itens públicos em uma API usando este padrão.
Para documentar um item de dentro do item (como dentro de um módulo), use //! ou /*! .. */, chamado de “comentários de documentação interna”:
Speaker Notes
This slide should take about 5 minutes.
- Mostre aos alunos os documentos gerados para o crate
randem [https://docs.rs/rand.