Doc comments

/// ile dokümantasyon yorumlarını öğrenirsin.

Doc comments

Doc comment'lar /// ile başlar (üç tane). Sıradan // yorumlarından farklı olarak dartdoc bunları okur ve HTML'e çevirir.

Bir satır /// veya çok satırlı bir /// bloğu yazılır; her satır /// ile başlamalıdır.

Sınıf, fonksiyon ve değişkenlerin üzerine yazılır. İlk cümle özet olarak kullanılır; bu yüzden kısa ve net olmalıdır.

Doc comment örneği

Tipik kullanım: /// Toplama yapar. satırının altına /// [a] ve [b] toplanır. eklersin, sonra fonksiyonu yazarsın.

Köşeli parantez [a], parametreye köprü oluşturur; dartdoc bunu tıklanabilir bağlantıya çevirir.

İlk satır kısa bir özet olmalı; ayrıntılar ikinci ve sonraki satırlara gelir.

Uygulama Çok satırlı doc comment

int add(int a, int b) => a + b; fonksiyonunu yaz. Üzerine iki satır doc comment ekle: birinci satır /// İki sayıyı toplar., ikinci satır /// [a] ve [b] toplanır.. main içinde print(add(2, 3)) çağır.

Örnek çözümü göster

/// İki sayıyı toplar.
/// [a] ve [b] toplanır.
int add(int a, int b) => a + b;

void main() {
  print(add(2, 3));
}

Kendini test et

Doc comment işareti

/// ____ İsmi selamlar.

Cevabı göster

/// /// İsmi selamlar.

Doc comment hangi işaretle başlar?
- //
- ///
- /*
- **
Cevabı göster

/// — /// doc comment, // sıradan yorumdur.
Doc comment parçaları

///

Doc comment
//

Normal yorum
[a]

Bağlantı
İlk cümle

Özet

Sıradaki ders: Markdown

Deneyiminizi Geliştiriyoruz

Çerez Tercihleri

Kesinlikle Gerekli Çerezler

Analitik Çerezler