Yorumlar
- Rust kursu
- Başlangıç
- Ders 5/115
- 4 dk
// ve /* */ yorumlarıyla kodunu açık etmeyi öğrenirsin.
Yorumlar
Rust'ta üç tür yorum vardır: // tek satır, /* ... */ çok satır ve /// belge yorumu. Belge yorumları cargo doc ile HTML belgeye dönüşür ve içindeki kod örnekleri test olarak çalıştırılır.
/// İki sayıyı toplar.
/// ```
/// assert_eq!(topla(2, 3), 5);
/// ```
fn topla(a: i32, b: i32) -> i32 {
a + b // sonuç ifade olarak döner
}İyi yorum
İyi yorum kodun ne yaptığını değil, neden öyle yaptığını açıklar. Kodun kendisi okunur adlarla ne yaptığını zaten anlatmalıdır. //! ise dosyanın ya da crate'in başında modülün tamamını belgeler.
// Kötü: i'yi bir artır
i += 1;
// İyi: başlık satırını atla
i += 1;Uygulama Belgeli fonksiyon
/// ile belgelenen fn kare(n: i32) -> i32 fonksiyonunu yaz ve main içinde bir // yorumunun altında println!("{}", kare(9)); çağır.
Başlangıç kodu
fn main() {
// buraya yaz
}Örnek çözüm
/// Sayının karesini döndürür.
fn kare(n: i32) -> i32 {
n * n
}
fn main() {
// 9'un karesini yazdır
println!("{}", kare(9));
}Beklenen çıktı
81
Soru ve cevaplar
Dersin sorularını cevaplarıyla birlikte inceleyebilirsin. Kendini denemek istersen dersi interaktif olarak çöz.
1 <code>///</code> yorumlarındaki kod örneklerine ne olur?
- Yalnızca IDE gösterir
- cargo test ile test olarak çalıştırılır Doğru cevap
- Yok sayılır
- Derleme hatası verir
Açıklama: Doc test denen bu özellik, belgedeki örneklerin güncel ve doğru kalmasını garanti eder.
2 Belge yorumu
____ Dairenin alanını hesaplar.
fn alan(r: f64) -> f64 { 3.14 * r * r }
/// Dairenin alanını hesaplar.
fn alan(r: f64) -> f64 { 3.14 * r * r }
Açıklama: /// sonrasındaki metin fonksiyonun belgesi olur.
3 Yorum türü
| Kavram | Anlamı |
|---|---|
// |
Tek satır |
/* */ |
Çok satır |
/// |
Öğe belgesi |
//! |
Modül belgesi |