Belge Testleri
Test edilen örnekler
Belge Testleri, CoddyKit'te ücretsiz bir Learn Rust Coding dersidir. Bu, 4 dersinin 4. dersidir. Aşağıdan dersin tamamını ücretsiz okuyabilir, sonra tarayıcıda yerleşik kod editörü ve 7/24 yapay zeka koçu ile uygulamalı olarak pratik yapabilirsin. Bu, Learn Rust Coding öğrenme yolunun bir parçasıdır ve ilerlemeniz web ve CoddyKit uygulaması arasında senkronize olur. Learn Rust Coding kursu toplamda 4 dersten oluşur.
Belge Testleri Nedir?
Belge testleri, belge yorumlarının içindeki ve Cargo'nun gerçekten derleyip çalıştırdığı kod örnekleridir. Belgelerinizin doğru, örneklerinizin çalışır durumda kalmasını sağlarlar.
Belge Yorumlarında Kod
Örnek kodu, bir /// yorumu içinde, # Examples başlığı altında, çitli bir kod bloğuna (üç ters tırnak) yerleştirin. Varsayılan dil Rust'tır.
/// Doubles a number.
///
/// # Examples
///
/// let result = my_crate::double(4);
/// assert_eq!(result, 8);
pub fn double(n: i32) -> i32 {
n * 2
}Belge Testlerini Çalıştırma
Belge testleri cargo test işleminin bir parçası olarak çalışır. Doc-tests bölümü altında ayrı olarak raporlanırlar.
cargo testÖrneklerde Doğrulamalar
Örneklerde genellikle doğrulamalar bulunur; böylece hatalı bir örnek yalnızca derlenmekle kalmaz, testi de başarısız kılar.
/// 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 }
}Kurulum Satırlarını Gizleme
Bir satırı çalıştırmak, ancak oluşturulan belgelerde gizlemek için satırın başına # koyun. İçeri aktarmalar gibi standart kodlar için kullanışlıdır.
/// # Examples
///
/// # use my_crate::Counter;
/// let mut c = Counter::new();
/// c.increment();
/// assert_eq!(c.value(), 1);Soru İşareti Kullanan Örnekler
? işlecini kullanmak için gövdeyi Result döndüren gizli bir main (veya yardımcı işlev) içine sarın. Gizli satırlar # ile başlar.
/// # Examples
///
/// # fn run() -> Result<(), std::num::ParseIntError> {
/// let n: i32 = "42".parse()?;
/// assert_eq!(n, 42);
/// # Ok(())
/// # }no_run Örnekleri
Çitli bir bloğu no_run açıklamasıyla işaretleyerek derlenmesini, ancak çalıştırılmamasını sağlayın; ağ veya dosya gerektiren örnekler için kullanışlıdır.
/// 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 ve should_panic
Kod çitindeki diğer açıklamalar:
ignore— ne derlenir ne de çalıştırılırshould_panic— paniğe yol açması beklenircompile_fail— derlenmemesi beklenir
Belge Testleri Neden Önemlidir?
Belge testleri aynı anda iki avantaj sağlar:
- Her zaman doğru olan belgeler
- Genel örnekleriniz için ücretsiz test kapsamı
Bir örnek bozulursa test paketi başarısız olur.
Örneklerde Crate Adı
Belge testleri crate'in dışından çalışıyormuş gibi yürütülür; bu nedenle öğelere crate adıyla (ör. my_crate::func) veya bir use içe aktarmasıyla başvurun.
Çitli ve Girintili Bloklar
Belge testleri iki blok stilini kabul eder:
no_rungibi açıklamalara izin veren, üç ters tırnak kullanan çitli blok- Bu örneklerde gösterilen, dört boşlukla girintilenmiş blok
Gerçek kodlarda çitli bloklar daha yaygındır.
Hızlı Kontrol
Belge testi kod bloğunda # ile başlayan bir satır ne yapar?
Özet
Belge testlerini öğrendiniz:
///bloklarındaki kodcargo testtarafından derlenir ve çalıştırılır- Davranışı doğrulamak için doğrulamaları kullanın
#, kurulum satırlarını oluşturulan belgelerde gizler- Açıklamalar:
no_run,ignore,should_panic,compile_fail - Örneklerin otomatik olarak doğru kalmasını sağlarlar
Sıkça Sorulan Sorular
“Belge Testleri” dersi ücretsiz mi?
Evet — “Belge Testleri” dersin tüm metni burada web'de ücretsiz olarak okunabilir. Etkileşimli olarak pratik yapmak (yerleşik kod editörü ve 7/24 yapay zeka koçu) ve Learn Rust Coding kursunun geri kalanını açmak için CoddyKit PRO'ya yükselt. Learn Rust Coding kursu toplamda 4 dersten oluşur.
“Belge Testleri” dersinde ne öğreneceğim?
Test edilen örnekler Learn Rust Coding ile uygulamalı kodu tarayıcıda doğrudan çalıştırarak pratik yaparsın ve 7/24 yapay zeka koçu dersi çalışırken sorularını yanıtlar.
Learn Rust Coding öğrenmeye başlamak için deneyim gerekli mi?
Önceden deneyim gerekmez. CoddyKit'te Learn Rust Coding, başlangıçtan ileri seviyeye kadar yapılandırıldığı için buradan başlayabilir veya başından başlayıp kendi hızında ilerleme yapabilirsin. Bu, 4 dersinin 4. dersidir.
“Belge Testleri” dersi ne kadar sürer?
Çoğu CoddyKit dersi yaklaşık 5–10 dakika sürer. Her biri kısa ve etkileşimli olduğu için sabit ilerleme yaparsın ve web ile uygulama arasında tam olarak bıraktığın yerden devam edebilirsin.
Bu Learn Rust Coding dersinde kod yazıp çalıştırabilir miyim?
Evet. Her Learn Rust Coding dersi yerleşik bir kod editörü içerir, bu sayede tarayıcıda gerçek kod yazıp çalıştırabilir ve anlık yapay zeka geri bildirimi alırsın — yerel kurulum gerekli değildir.
Bu kursun tüm dersleri
- Birim Testleri
- Tümleştirme Testleri
- Belge Açıklamaları
- Belge Testleri