คอมเมนต์เอกสาร
เอกสารประกอบ ///
คอมเมนต์เอกสาร เป็นบทเรียน Learn Rust Coding ฟรีบน CoddyKit นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน คุณสามารถอ่านบทเรียนทั้งหมดด้านล่างฟรี — จากนั้นลองปฏิบัติด้วยตัวคุณเองในเบราว์เซอร์พร้อมตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7 บทเรียนนี้เป็นส่วนหนึ่งของเส้นทางการเรียน Learn Rust Coding และความก้าวหน้าของคุณจะซิงค์ข้ามเว็บและแอป CoddyKit คอร์ส Learn Rust Coding มีบทเรียนทั้งหมด 4 บทเรียน
เอกสารประกอบใน Rust
Rust มีระบบเอกสารประกอบชั้นหนึ่งในตัวภาษา ความคิดเห็นพิเศษจะกลายเป็นเอกสาร HTML ที่สร้างโดย cargo doc
ความคิดเห็นเอกสารภายนอก
ใช้ /// เพื่อจัดทำเอกสารให้รายการที่ตามหลังความคิดเห็นนั้น เช่น ฟังก์ชัน โครงสร้าง อีนัม และอื่น ๆ ข้อความรองรับ Markdown
/// Adds two numbers together.
pub fn add(a: i32, b: i32) -> i32 {
a + b
}การจัดรูปแบบด้วย Markdown
ความคิดเห็นเอกสารจะแสดงผล Markdown ได้ทั้งหัวข้อ รายการ ตัวหนา และลิงก์ โค้ดในบรรทัดใช้ backtick และหัวข้อส่วนเริ่มต้นด้วย #
/// Computes the area of a rectangle.
///
/// # Arguments
/// * width - the width
/// * height - the height
pub fn area(width: u32, height: u32) -> u32 {
width * height
}ส่วนเอกสารที่ใช้กันทั่วไป
หัวข้อตามธรรมเนียมช่วยให้กวาดตาอ่านเอกสารได้ง่าย:
# Examples— ตัวอย่างการใช้งาน# Panics— กรณีที่เกิด panic# Errors— ข้อผิดพลาดที่คืนค่า# Safety— เงื่อนไขคงที่สำหรับโค้ดที่ไม่ปลอดภัย
ความคิดเห็นเอกสารภายใน
ใช้ //! เพื่อจัดทำเอกสารให้รายการที่ครอบคลุมอยู่ โดยทั่วไปคือโมดูลหรือ crate ทั้งหมด ให้วางไว้ด้านบนสุดของไฟล์
//! # My Math Crate
//!
//! Utilities for basic arithmetic.
pub fn double(n: i32) -> i32 {
n * 2
}การจัดทำเอกสารโครงสร้างและฟิลด์
รายการสาธารณะแต่ละรายการ รวมถึงฟิลด์ของโครงสร้าง สามารถมีความคิดเห็นเอกสารของตนเองได้
/// A point in 2D space.
pub struct Point {
/// The horizontal coordinate.
pub x: f64,
/// The vertical coordinate.
pub y: f64,
}การสร้างเอกสาร
cargo doc สร้างเอกสาร HTML ลงใน target/doc เพิ่ม --open เพื่อเปิดดูในเบราว์เซอร์
cargo doc --openการยกเว้นการพึ่งพา
โดยค่าเริ่มต้น Cargo จะจัดทำเอกสารให้การพึ่งพาของคุณด้วย ใช้ --no-deps เพื่อสร้างเอกสารเฉพาะ crate ของคุณ
cargo doc --no-deps --openลิงก์ภายในเอกสาร
ลิงก์ไปยังรายการอื่นโดยเขียนเส้นทางของรายการนั้นไว้ภายในวงเล็บเหลี่ยม Rust จะระบุเส้นทางและสร้างลิงก์ที่คลิกได้ในเอกสารที่สร้างขึ้น
/// See also [add] for addition.
///
/// [add]: crate::add
pub fn subtract(a: i32, b: i32) -> i32 {
a - b
}เหตุใดจึงควรจัดทำเอกสาร
เอกสารที่ดีให้ประโยชน์มาก:
- สร้างเป็น HTML ที่ค้นหาได้โดยอัตโนมัติ
- เผยแพร่ไปยัง docs.rs ได้ฟรีเมื่อคุณเผยแพร่ crate
- ตัวอย่างในเอกสารจะถูกทดสอบ (การทดสอบเอกสาร)
- ช่วยเพื่อนร่วมทีมและตัวคุณในอนาคต
การจัดทำเอกสารโมดูล
ใช้ความคิดเห็นภายในและภายนอกร่วมกัน: ไฟล์โมดูลเริ่มต้นด้วย //! ที่อธิบายโมดูล และแต่ละรายการภายในใช้ ///
//! Geometry helpers.
/// Returns the perimeter of a square.
pub fn perimeter(side: f64) -> f64 {
side * 4.0
}ตรวจสอบอย่างรวดเร็ว
ไวยากรณ์ความคิดเห็นใดใช้จัดทำเอกสารให้รายการที่อยู่ถัดจากความคิดเห็นทันที
สรุปทบทวน
คุณได้เรียนรู้ความคิดเห็นเอกสาร:
///จัดทำเอกสารให้รายการถัดไป ส่วน//!จัดทำเอกสารให้รายการที่ครอบคลุมอยู่- รองรับ Markdown และส่วนต่าง ๆ เช่น
# Examples - ลิงก์ภายในเอกสารเชื่อมโยงรายการต่าง ๆ
cargo doc --openสร้างและเปิดดูเอกสาร HTML
เรียนรู้ Rust ด้วย AI tutor — ฟรี
เขียนและเรียกใช้โค้ดจริงในเบราว์เซอร์ของคุณ รับความช่วยเหลือทันทีจาก AI tutor 24/7 และเรียนรู้ต่อจากที่คุณหยุดบนเว็บหรือในแอป
- คอร์ส
- 39
- บทเรียน
- 144
คำถามที่พบบ่อย
บทเรียน “คอมเมนต์เอกสาร” ฟรีหรือไม่
ใช่ — ข้อความเต็มของ “คอมเมนต์เอกสาร” ฟรีให้อ่านที่นี่บนเว็บ เพื่อปฏิบัติแบบโต้ตอบ (ตัวแก้ไขโค้ดในตัวและติวเตอร์ AI ตลอด 24/7) และปลดล็อคส่วนที่เหลือของคอร์ส Learn Rust Coding ให้อัปเกรดเป็น CoddyKit PRO คอร์ส Learn Rust Coding มีบทเรียนทั้งหมด 4 บทเรียน
คุณจะเรียนรู้อะไรในบทเรียน “คอมเมนต์เอกสาร”
เอกสารประกอบ /// คุณปฏิบัติ Learn Rust Coding ด้วยโค้ดที่ใช้งานได้จริงที่คุณเรียกใช้โดยตรงในเบราว์เซอร์ และติวเตอร์ AI ตลอด 24/7 ตอบคำถามของคุณขณะที่คุณไปผ่านบทเรียน
คุณต้องมีประสบการณ์ก่อนที่จะเริ่มเรียน Learn Rust Coding หรือไม่
ไม่จำเป็นต้องมีประสบการณ์มาก่อน Learn Rust Coding บน CoddyKit ออกแบบมาสำหรับผู้เริ่มต้นไปจนถึงผู้เรียนขั้นสูง คุณสามารถเริ่มต้นที่นี่หรือเริ่มจากตัวแรกและเรียนด้วยความเร็วของคุณเอง นี่คือบทเรียนที่ 3 จากทั้งหมด 4 บทเรียน
บทเรียน “คอมเมนต์เอกสาร” ใช้เวลานานแค่ไหน
บทเรียน CoddyKit ส่วนใหญ่ใช้เวลาประมาณ 5–10 นาที แต่ละบทเรียนจึงสั้นและเป็นแบบโต้ตอบ คุณสามารถก้าวหน้าอย่างต่อเนื่องและกลับมาเรียนต่อจากตรงที่เพิ่งหยุดบนเว็บและแอปได้เลย
ฉันเขียนและรันโค้ดในบทเรียน Learn Rust Coding นี้ได้ไหม
ได้ บทเรียน Learn Rust Coding ทุกบทมีตัวแก้ไขโค้ดในตัว คุณจึงเขียนและรันโค้ดจริงได้เลยในเบราว์เซอร์ และได้รับข้อเสนอแนะจาก AI ในทันที — ไม่ต้องติดตั้งในเครื่องของคุณ
บทเรียนทั้งหมดในหลักสูตรนี้
- การทดสอบหน่วย
- การทดสอบการผสานรวม
- คอมเมนต์เอกสาร
- การทดสอบเอกสาร