Comments & Docs

การเขียนโค้ดที่ดี ไม่ใช่แค่เขียนให้คอมพิวเตอร์เข้าใจครับ แต่ต้องเขียนให้คน (หรือตัวเราในอนาคต) เข้าใจด้วย Rust ให้ความสำคัญกับเรื่องนี้มาก จนมีระบบ Documentation ที่ Built-in มาให้เลย ถือว่าเป็นจุดเด่นที่ภาษาอื่นๆ หลายตัวยังทำไม่ได้ดีเท่า

Comments ทั่วไป - Regular Comments

Line Comments (//)

Comment แบบบรรทัดเดียว นิยมใช้มากที่สุดใน Rust เพราะสะอาดตาและอ่านง่าย

fn main() {
    // ============================================
    // // = Line Comment (บรรทัดเดียว)
    // Compiler จะมองข้ามบรรทัดนี้ไปเลย
    // ============================================

    let x = 5; // สามารถใส่ท้ายบรรทัดโค้ดได้ด้วย

    // ============================================
    // ใช้หลายบรรทัดติดกันก็ได้
    // เหมือนเขียนย่อหน้าสั้นๆ
    // อธิบายโค้ดส่วนที่ซับซ้อน
    // ============================================
    let y = x * 2;

    println!("y = {}", y);
}