Learn Rust Coding · Pelajaran

Komentar Dokumentasi

Dokumentasi ///

Komentar Dokumentasi adalah pelajaran Learn Rust Coding gratis di CoddyKit. Ini adalah pelajaran 3 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Learn Rust Coding, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Learn Rust Coding mencakup 4 pelajaran total.

Dokumentasi dalam Rust

Rust memiliki dokumentasi kelas satu yang terintegrasi dalam bahasa. Komentar khusus menjadi dokumentasi HTML yang dibuat oleh cargo doc.

Komentar Dokumentasi Luar

Gunakan /// untuk mendokumentasikan item yang mengikutinya—fungsi, struct, enum, dan lainnya. Teksnya mendukung Markdown.

/// Adds two numbers together.
pub fn add(a: i32, b: i32) -> i32 {
    a + b
}

Pemformatan Markdown

Komentar dokumentasi dirender sebagai Markdown: judul, daftar, teks tebal, dan tautan semuanya berfungsi. Kode sebaris menggunakan backtick, dan judul bagian diawali dengan #.

/// Computes the area of a rectangle.
///
/// # Arguments
/// * width - the width
/// * height - the height
pub fn area(width: u32, height: u32) -> u32 {
    width * height
}

Bagian Dokumentasi Umum

Judul konvensional membuat dokumentasi mudah dipindai:

# Examples — contoh penggunaan
# Panics — kapan terjadi panic
# Errors — kesalahan yang dikembalikan
# Safety — invarian untuk kode tidak aman

Komentar Dokumentasi Dalam

Gunakan //! untuk mendokumentasikan item yang melingkupinya, biasanya modul atau seluruh peti. Letakkan komentar ini di bagian atas berkas.

//! # My Math Crate
//!
//! Utilities for basic arithmetic.

pub fn double(n: i32) -> i32 {
    n * 2
}

Mendokumentasikan Struct dan Field

Setiap item publik, termasuk field struct, dapat memiliki komentar dokumentasinya sendiri.

/// A point in 2D space.
pub struct Point {
    /// The horizontal coordinate.
    pub x: f64,
    /// The vertical coordinate.
    pub y: f64,
}

Membuat Dokumentasi

cargo doc membangun dokumentasi HTML ke dalam target/doc. Tambahkan --open untuk melihatnya di peramban.

cargo doc --open

Mengecualikan Dependensi

Secara bawaan Cargo juga mendokumentasikan dependensi Anda. Gunakan --no-deps untuk membangun dokumentasi hanya untuk peti Anda.

cargo doc --no-deps --open

Tautan Antar-Dokumentasi

Tautkan ke item lain dengan menulis path-nya di dalam kurung siku. Rust menyelesaikan path tersebut dan membuat tautan yang dapat diklik dalam dokumentasi yang dihasilkan.

/// See also [add] for addition.
///
/// [add]: crate::add
pub fn subtract(a: i32, b: i32) -> i32 {
    a - b
}

Mengapa Membuat Dokumentasi?

Dokumentasi yang baik memberikan manfaat:

Dibuat otomatis menjadi HTML yang dapat dicari
Diterbitkan secara gratis ke docs.rs saat Anda menerbitkan peti
Contoh dalam dokumentasi diuji (pengujian dokumentasi)
Membantu rekan satu tim dan diri Anda di masa mendatang

Mendokumentasikan Modul

Gabungkan komentar dalam dan luar: berkas modul diawali dengan //! yang menjelaskan modul, dan setiap item di dalamnya menggunakan ///.

//! Geometry helpers.

/// Returns the perimeter of a square.
pub fn perimeter(side: f64) -> f64 {
    side * 4.0
}

Pemeriksaan Singkat

Sintaks komentar mana yang mendokumentasikan item yang langsung mengikutinya?

Ringkasan

Anda telah mempelajari komentar dokumentasi:

/// mendokumentasikan item berikutnya; //! mendokumentasikan item yang melingkupinya
Komentar tersebut mendukung Markdown dan bagian seperti # Examples
Tautan antar-dokumentasi menghubungkan item
cargo doc --open membuat dan menampilkan dokumentasi HTML

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Komentar Dokumentasi” gratis?

Ya — teks lengkap “Komentar Dokumentasi” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Learn Rust Coding, upgrade ke CoddyKit PRO. Kursus Learn Rust Coding mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “Komentar Dokumentasi”?

Dokumentasi /// Kamu berlatih Learn Rust Coding dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.

Apakah aku perlu pengalaman untuk memulai Learn Rust Coding?

Tidak diperlukan pengalaman sebelumnya. Learn Rust Coding di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 3 dari 4.

Berapa lama pelajaran “Komentar Dokumentasi” memakan waktu?

Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.

Bisakah aku menulis dan menjalankan kode dalam pelajaran Learn Rust Coding ini?

Ya. Setiap pelajaran Learn Rust Coding menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.

Semua pelajaran dalam kursus ini

← Kembali ke Learn Rust Coding