Rust · Intermediário · Inglês · Técnico
doctest
Exemplo de código dentro de um comentário de documentação, em cercas de código, que o cargo test compila e executa. Mantém a documentação sempre correta.
Onde usar
Aparece em /// acima de funções públicas. Linhas começadas com # ficam ocultas na documentação e escondem o setup.
Em código
/// Soma dois números.
///
/// ```
/// assert_eq!(meucrate::soma(1, 2), 3);
/// ```
pub fn soma(a: i32, b: i32) -> i32 {
a + b
}Exemplos
Add a doctest so the example stays correct.
Adicione um doctest para o exemplo continuar correto.
The doctest fails because of a missing import.
O doctest falha por falta de um import.
Cuidado
O doctest é compilado como uma crate à parte, então só enxerga a API pública e precisa dos próprios imports.
Sinônimos
teste de documentação