Yorum satırları programların olmazsa olmazlarıdır. Rust birkaç farklı yorum satırını destekler.
// Bu bir satır içi yorumdur
/* Bu ise sonlandırma imi bildirilene kadar tüm bloğu kapsar */
/* Rust /* iç içe yapılan blok */ yorumlarını da destekler.*/💡 Her ne kadar blok yorumlarını destekleniyorsa da, geleneksel olarak satır içi yorum kullanılması tercih edilmektedir.
/// Satır içi yorumlar: Bir alttaki öğeyi belgeler
/** Blok Yorumu: Bir alttaki öğeyi belgeler */
//! Satır içi yorumlar: Alt parçadaki öğeyi kapsam boyunca belgeler
/*! Blok Yorumu: Alt parçadaki öğeyi kapsam boyunca belgeler !*/Döküman yorumları markdown gösterimlerini destekler. Bu yorum satırlarına sahip programlar cargo doc komutu kullanılarak HTML biçiminde belgelendirilir. Aşağıdaki örnekte her iki doküman yorum seti aynı modülü belgelemek için kullanılıyor. Aralarındaki farkı inceleyelim:
/// Modül testlerini içerir
mod test {
// ...
} Dikkat ederseniz yukarıdaki yorum seti modülün önüne getirilirken, altta bulunan yorum setiyse modül içinde yer almaktadır.
mod test {
//! Burası da Modül testlerini içerir
// ...
}💡 Sandık ve modül düzeyinde belgeleme yapmak için sadece //! kullanmak yeterlidir. Eğer ilk örnekteki gibi mod blokları belgelenecekse /// yorum satırı mod bloğunun dışında kullanılır.
Kodların belgelenmesinde döküman niteliklerinden de yararlanabiliriz. Aşağıdaki örnekte bulunan her yorum ilgili verinin niteliklerine eşdeğerdir.
/// Foo
#[doc="Foo"]
//! Foo
#![doc="Foo"]🔎 Bir Öznitelik; ad, kural, dil ve derleyici sürümüne göre yorumlanan genel, serbest biçimli bir metadatadır. Herhangi bir öğe bildiriminin kendisine uygulanan bir özelliği olabilir. Daha fazla bilgi için Rust kitabının 14. bölümünde yer alan Bir Sandığı Yayınlamak adlı konu başlığını veya Türkçe Belgelerini inceleyebilirsiniz.