Learn Rust Coding · Ders

Belge Açıklamaları

/// belgeleri

Belge Açıklamaları, CoddyKit'te ücretsiz bir Learn Rust Coding dersidir. Bu, 4 dersinin 3. 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.

Rust'ta Belgelendirme

Rust'ta dile yerleşik, birinci sınıf belgelendirme desteği vardır. Özel yorumlar, cargo doc tarafından oluşturulan HTML belgelerine dönüştürülür.

Dış Belge Yorumları

Kendisinden sonra gelen öğeyi (işlevleri, yapı türlerini, enum'ları ve daha fazlasını) belgelemek için /// kullanın. Metin Markdown'u destekler.

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

Markdown Biçimlendirmesi

Belge yorumları Markdown olarak işlenir: başlıklar, listeler, kalın metin ve bağlantıların tümü çalışır. Satır içi kod için ters tırnaklar kullanılır; bölüm başlıkları # ile başlar.

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

Yaygın Belge Bölümleri

Geleneksel başlıklar belgelerin kolay taranmasını sağlar:

# Examples — kullanım örnekleri
# Panics — paniğe yol açtığı durumlar
# Errors — döndürdüğü hatalar
# Safety — güvenli olmayan kod için değişmez koşullar

İç Belge Yorumları

Çevreleyen öğeyi (genellikle bir modülü veya crate'in tamamını) belgelemek için //! kullanın. Bunu dosyanın en üstüne yerleştirin.

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

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

Yapı Türlerini ve Alanlarını Belgeleme

Yapı alanları da dahil olmak üzere her genel öğenin kendine ait bir belge yorumu olabilir.

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

Belge Oluşturma

cargo doc, HTML belgelerini target/doc içine oluşturur. Belgeleri tarayıcınızda görüntülemek için --open ekleyin.

cargo doc --open

Bağımlılıkları Dışarıda Bırakma

Cargo varsayılan olarak bağımlılıklarınızı da belgeler. Yalnızca crate'iniz için belge oluşturmak üzere --no-deps kullanın.

cargo doc --no-deps --open

Belge İçi Bağlantılar

Köşeli parantezlerin içine yollarını yazarak diğer öğelere bağlantı verin. Rust yolu çözer ve oluşturulan belgelerde tıklanabilir bir bağlantı oluşturur.

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

Neden Belge Yazmalısınız?

İyi belgeler fayda sağlar:

Aranabilir HTML olarak otomatik oluşturulur
Bir crate yayımladığınızda docs.rs üzerinde ücretsiz yayımlanır
Belgelerdeki örnekler test edilir (belge testleri)
Ekip arkadaşlarınıza ve gelecekteki size yardımcı olur

Bir Modülü Belgeleme

İç ve dış yorumları birleştirin: bir modül dosyası modülü açıklayan //! ile başlar; içindeki her öğe ise /// kullanır.

//! Geometry helpers.

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

Hızlı Kontrol

Hemen ardından gelen öğeyi hangi yorum söz dizimi belgeler?

Özet

Belge yorumlarını öğrendiniz:

/// sonraki öğeyi, //! ise çevreleyen öğeyi belgeler
Markdown'u ve # Examples gibi bölümleri desteklerler
Belge içi bağlantılar öğeleri birbirine bağlar
cargo doc --open HTML belgelerini oluşturur ve görüntüler

Sıkça Sorulan Sorular

“Belge Açıklamaları” dersi ücretsiz mi?

Evet — “Belge Açıklamaları” 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 Açıklamaları” dersinde ne öğreneceğim?

/// belgeleri 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 3. dersidir.

“Belge Açıklamaları” 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

← Learn Rust Coding Sayfasına Dön