¿Cómo puedo escribir documentación en toda la caja?
Con el fin de garantizar que todos los artefactos públicos de mi caja estén documentados (si es mínimo), especifiqué#![deny(missing_docs)]
en milib.rs
Sin embargo, fue contraproducente.
Esperaba escribir código así, ese es un comentario de documentación en la parte superior y el código después:
/// Hello world example for Rust.
#![deny(missing_docs)]
fn main() {
println!("Hello world!");
}
Esto falla con:
3:3: 3:4 error: an inner attribute is not permitted in this context
3 #![deny(missing_docs)]
Revertir el orden, atributos primero y comentario segundo:
#![deny(missing_docs)]
/// Hello world example for Rust.
fn main() {
println!("Hello world!");
}
También falla:
1:1: 7:1 error: missing documentation for crate
1 #![deny(missing_docs)]
y en ninguna parte delsección de documentación del libro ¿Cómo puedo escribir documentación para la caja en sí?
Entonces, ¿cómo debo escribir la documentación de la caja para satisfacer#![deny(missing_docs)]
?