Rust 代碼文件中,通常我們可以看到 3 種注釋。
//
后的,直到行尾,都屬于注釋,不會(huì)影響程序的行為。
// 創(chuàng)建一個(gè)綁定
let x = 5;
let y = 6; // 創(chuàng)建另一個(gè)綁定
文檔注釋使用 ///
,一般用于函數(shù)或結(jié)構(gòu)體(字段)的說明,置于要說明的對(duì)象上方。文檔注釋內(nèi)部可使用markdown格式的標(biāo)記語法,可用于 rustdoc 工具的自動(dòng)文檔提取。
/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let five = 5;
///
/// assert_eq!(6, add_one(5));
/// # fn add_one(x: i32) -> i32 {
/// # x + 1
/// # }
/// ```
fn add_one(x: i32) -> i32 {
x + 1
}
模塊注釋使用 //!
,用于說明本模塊的功能。一般置于模塊文件的頭部。
//! # The Rust Standard Library
//!
//! The Rust Standard Library provides the essential runtime
//! functionality for building portable Rust software.
PS: 相對(duì)于 ///
, //!
用來注釋包含它的項(xiàng)(也就是說,crate,模塊或者函數(shù)),而不是位于它之后的項(xiàng)。
Rust 也支持兼容 C 的塊注釋寫法:/* */
。但是不推薦使用,請(qǐng)盡量不要使用這種注釋風(fēng)格(會(huì)被鄙視的)。
/*
let x = 42;
println!("{}", x);
*/