你如何記錄函數參數？

rustdoc允許您通過包括每個行之前的文檔註釋記錄結構域和枚舉變量：你如何記錄函數參數？

enum Choices { 
    /// The first choice. 
    First, 
    /// The second choice. 
    Second, 
} 

struct Person { 
    /// The person's name. 
    name: String, 
    /// The person's age. 
    age: u8, 
}

這些將出現在由rustdoc生成的HTML格式不錯。但是，我還沒有看到爲函數參數製作類似的格式良好的文檔。有沒有一種「官方」的方式來記錄它們，或者你只需要在函數的主要文檔部分中自由地描述它們？

來源

2015-05-03 Jimmy Cuadra

FWIW，我更喜歡利用類型系統。而不是說「這個u8必須是2或者1的冪」，用適當的構造函數創建一個'PowerOfTwoOrPrime'新類型。 – Shepmaster

沒有語法，也沒有建立準則/約定。 – bluss

我見過一些例子使用以下樣式：

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

到目前爲止，它的正常工作對我來說太。

來源

2015-05-03 11:01:09 ArtemGr

是否有一個「正式」的方式來記錄這些

目前還不能記錄參數進行正式的方式。

來源

2015-05-03 22:47:50

你如何記錄函數參數？

回答

相關問題