rustdoc permette di documentare i campi struct e varianti enum includendo un commento di documentazione sopra ogni riga:Come si documentano gli argomenti delle funzioni?
enum Choices {
/// The first choice.
First,
/// The second choice.
Second,
}
struct Person {
/// The person's name.
name: String,
/// The person's age.
age: u8,
}
Questi verranno visualizzati con una bella formattazione in HTML generato da rustdoc. Tuttavia, non ho visto alcun modo di creare documenti simili ben formattati per gli argomenti delle funzioni. Esiste un modo "ufficiale" per documentarli o devi solo descriverli in forma libera nella sezione della documentazione principale della funzione?
FWIW, preferisco sfruttare il sistema di tipi. Invece di dire "Questo u8 deve essere una potenza di 2 o primo", crea un nuovo tipo 'PowerOfTwoOrPrime' con un costruttore appropriato. – Shepmaster
Nessuna sintassi per questo né le linee guida/convenzioni stabilite. – bluss