Rust 函式文件注釋

2022-09-18 00:33:13 字數 705 閱讀 7701

參考:

文件注釋可以生成 html 檢視,支援 markdown 格式。

/// 主函式

fn main() ", x);

}/// 加法函式

fn add(x: i32, y: i32) -> i32

可以使用命令cargo doc來生成文件注釋的 html 格式,在target/doc目錄下:

ps c:\users\jiangbo\work\workspace\rust\hello_world> cargo doc

documenting hello_world v0.1.0 (c:\users\jiangbo\work\workspace\rust\hello_world)

finished dev [unoptimized + debuginfo] target(s) in 0.79s

如果想直接檢視文件,可以開啟生成的文件,也可以直接使用cargo doc --open命令。

介紹了 rust 中的函式文件注釋的使用方式,生成、開啟、檢視文件注釋。

Rust學習四 rust的函式 注釋與控制流

rust以fn為關鍵字宣告乙個函式。函式命名規範為全小寫,以下劃線為分隔的單詞。fn main 多個引數以逗號分隔,函式引數必須指定資料型別 fn test x i32,y u64 函式體由一系列的以表示式結尾的語句組成。到目前為止我們只涉及了沒有表示式結尾的函式,但是能看出表示式是語句的一部分。因...

Rust學習筆記(三) 注釋

和大多數高階語言一樣,rust同樣支援單行注釋和多行注釋。單行注釋是 或 開頭的注釋內容,rust會將 或 到其後的第乙個換行符之間的內容作為注釋內容。所不同的是,以三個反斜槓 開頭注釋,只能放在 的最前面,作為整個檔案的注釋內容。而以兩個反斜槓 開頭注釋,可以放在任意位置。這是單行注釋 三個反斜槓...

Swift文件注釋

a dome method param input an int number returns the string represents the input number func method input int string return string input 在文件注釋的塊中 在這裡是被...