Come si documentano gli argomenti delle funzioni?

Question

rustdoc permette di documentare i campi struct e varianti enum includendo un commento di documentazione sopra ogni riga:

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?

Answer 1

Ho visto lo stile segue utilizzato in alcuni degli esempi:

/// Brief. 
/// 
/// Description. 
/// 
/// * `foo` - Text about foo. 
/// * `bar` - Text about bar. 
fn function (foo: i32, bar: &str) {} 

Finora sta funzionando bene anche per me.

Answer 2

C'è un modo "ufficiale" per documentare loro

Non c'è attualmente un modo ufficiale per documentare argomenti.