Learn Rust Coding · Pelajaran

Pengujian Dokumentasi

Contoh yang diuji

Pengujian Dokumentasi adalah pelajaran Learn Rust Coding gratis di CoddyKit. Ini adalah pelajaran 4 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.

Apa Itu Pengujian Dokumentasi?

Pengujian dokumentasi adalah contoh kode di dalam komentar dokumentasi yang benar-benar dikompilasi dan dijalankan oleh Cargo. Pengujian ini menjaga dokumentasi tetap benar dan contoh tetap berfungsi.

Kode dalam Komentar Dokumentasi

Letakkan kode contoh dalam blok kode berpagar (tiga backtick) di dalam komentar ///, di bawah judul # Examples. Bahasa bawaannya adalah Rust.

/// Doubles a number.
///
/// # Examples
///
///     let result = my_crate::double(4);
///     assert_eq!(result, 8);
pub fn double(n: i32) -> i32 {
    n * 2
}

Menjalankan Pengujian Dokumentasi

Pengujian dokumentasi dijalankan sebagai bagian dari cargo test. Hasilnya dilaporkan secara terpisah di bagian Doc-tests.

cargo test

Pernyataan dalam Contoh

Contoh biasanya menyertakan pernyataan agar contoh yang salah membuat pengujian gagal, bukan sekadar berhasil dikompilasi.

/// Returns the larger of two values.
///
/// # Examples
///
///     assert_eq!(my_crate::max(3, 7), 7);
///     assert_eq!(my_crate::max(9, 2), 9);
pub fn max(a: i32, b: i32) -> i32 {
    if a > b { a } else { b }
}

Menyembunyikan Baris Penyiapan

Awali sebuah baris dengan # untuk menjalankannya, tetapi menyembunyikannya dari dokumentasi yang dirender. Berguna untuk kode penyiapan seperti impor.

/// # Examples
///
///     # use my_crate::Counter;
///     let mut c = Counter::new();
///     c.increment();
///     assert_eq!(c.value(), 1);

Contoh Menggunakan Tanda Tanya

Untuk menggunakan operator ?, bungkus isi program dalam main tersembunyi (atau fungsi pembantu) yang mengembalikan Result. Baris tersembunyi diawali dengan #.

/// # Examples
///
///     # fn run() -> Result<(), std::num::ParseIntError> {
///     let n: i32 = "42".parse()?;
///     assert_eq!(n, 42);
///     # Ok(())
///     # }

Contoh no_run

Tandai blok berpagar dengan anotasi no_run agar blok tersebut dikompilasi tetapi tidak dijalankan — berguna untuk contoh yang memerlukan jaringan atau berkas.

/// Fetches a page (compiled but not executed).
///
/// Annotate the code fence with no_run so it is type-checked only.
pub fn fetch(url: &str) -> String {
    format!("contents of {url}")
}

ignore dan should_panic

Anotasi lain pada pagar kode:

ignore — tidak dikompilasi maupun dijalankan
should_panic — diharapkan mengalami panic
compile_fail — diharapkan gagal dikompilasi

Mengapa Uji Dokumentasi Penting

Uji dokumentasi memberi Anda dua manfaat sekaligus:

Dokumentasi yang selalu akurat
Cakupan pengujian gratis untuk contoh publik Anda

Jika sebuah contoh rusak, rangkaian pengujian akan gagal.

Nama Crate dalam Contoh

Uji dokumentasi dijalankan seolah-olah dari luar crate, jadi rujuk item melalui nama crate (misalnya my_crate::func) atau impor use.

Blok Berpagar vs Menjorok

Uji dokumentasi menerima dua gaya blok:

Blok berpagar menggunakan tiga tanda backtick, yang memungkinkan anotasi seperti no_run
Blok menjorok (empat spasi), seperti yang ditampilkan dalam contoh-contoh ini

Blok berpagar lebih umum dalam kode nyata.

Pemeriksaan Singkat

Apa yang dilakukan baris yang diawali # di dalam blok kode uji dokumentasi?

Ringkasan

Anda telah mempelajari uji dokumentasi:

Kode dalam blok /// dikompilasi dan dijalankan oleh cargo test
Gunakan pernyataan penegasan untuk memverifikasi perilaku
# menyembunyikan baris penyiapan dari dokumentasi yang dirender
Anotasi: no_run, ignore, should_panic, compile_fail
Contoh tetap benar secara otomatis

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Pengujian Dokumentasi” gratis?

Ya — teks lengkap “Pengujian 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 “Pengujian Dokumentasi”?

Contoh yang diuji 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 4 dari 4.

Berapa lama pelajaran “Pengujian 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