คอมเมนต์
โปรแกรมเมอร์ทุกคนต่างพยายามเขียนโค้ดให้อ่านและเข้าใจง่าย แต่บางครั้งการเขียนคำอธิบายเพิ่มเติมก็มีประโยชน์อย่างยิ่ง ในกรณีเช่นนี้ โปรแกรมเมอร์จะเขียน คอมเมนต์ (comment) ทิ้งไว้ในซอร์สโค้ด ซึ่งคอมไพเลอร์จะมองข้ามข้อความเหล่านี้ไป แต่ผู้อ่านโค้ดจะได้รับประโยชน์จากคำอธิบายดังกล่าว
นี่คือตัวอย่างคอมเมนต์แบบเรียบง่าย:
#![allow(unused)]
fn main() {
// hello, world
}
ใน Rust รูปแบบคอมเมนต์มาตรฐานที่นิยมใช้จะเริ่มต้นด้วยเครื่องหมายทับสองตัว (//) และข้อความคอมเมนต์จะครอบคลุมไปจนจบบรรทัดนั้น สำหรับคอมเมนต์ที่มีความยาวเกินหนึ่งบรรทัด คุณจะต้องใส่ // ไว้ที่ต้นบรรทัดของแต่ละบรรทัด ดังนี้:
#![allow(unused)]
fn main() {
// So we're doing something complicated here, long enough that we need
// multiple lines of comments to do it! Whew! Hopefully, this comment will
// explain what's going on.
}
นอกจากนี้ เรายังสามารถวางคอมเมนต์ไว้ท้ายบรรทัดคำสั่งได้ด้วย:
ชื่อไฟล์: src/main.rs
fn main() {
let lucky_number = 7; // I'm feeling lucky today
}
อย่างไรก็ดี คุณมักจะพบเห็นการเขียนคอมเมนต์ในรูปแบบแยกบรรทัดไว้เหนือโค้ดที่ต้องการอธิบายมากกว่า:
ชื่อไฟล์: src/main.rs
fn main() {
// I'm feeling lucky today
let lucky_number = 7;
}
Rust ยังมีคอมเมนต์อีกประเภทหนึ่ง นั่นคือคอมเมนต์เอกสาร (documentation comment) ซึ่งเราจะกล่าวถึงในหัวข้อ “การเผยแพร่เครตไปยัง Crates.io” ในบทที่ 14