dartdoc

dartdoc ile dokümantasyon üretimini öğrenirsin.

dartdoc

dartdoc, Dart'ın resmi dokümantasyon üreticisidir. Kaynak kodundaki doc comment'ları (///) okur ve HTML dokümantasyonu üretir.

Komut: dart doc (yeni ad) veya dartdoc (eski). Çıktı varsayılan olarak doc/api/ klasörüne yazılır.

Paketlerde her public API için doc comment yazmak iyi bir uygulamadır; dartdoc bunları otomatik toplar.

dart doc komutu

dart doc komutu lib/ altındaki dosyaları tarar, /// yorumlarını toplar ve doc/api/ klasörüne HTML üretir.

--output seçeneği ile çıktı yerini değiştirebilirsin: dart doc --output build/docs. Bu, derleme sistemlerine uygun çıktı verir.

Üretilen HTML'i bir tarayıcıda açarak paketinin API belgelerinde gezebilirsin; her public sınıf ve metot ayrı bir sayfada görünür.

Uygulama dartdoc için doc comment

String greet(String name) => 'Merhaba $name'; fonksiyonunu yaz. Üzerine bir doc comment ekle: /// İsmi selamlar.. main içinde print(greet('Ayşe')) çağrısını yazdır.

Örnek çözümü göster

/// İsmi selamlar.
String greet(String name) => 'Merhaba $name';

void main() {
  print(greet('Ayşe'));
}

Kendini test et

dartdoc ne üretir?
- HTML dokümantasyon
- Çalıştırılabilir kod
- Test raporu
- Paket dosyası
Cevabı göster

HTML dokümantasyon — dartdoc doc comment'lardan HTML sayfalar üretir.

dart doc komutu

dart ____ --output build/docs

Cevabı göster

dart doc --output build/docs

dartdoc parçaları

dart doc

Komut
///

Doc comment
lib/

Taranan klasör
HTML

Çıktı biçimi

Sıradaki ders: Doc comments

Deneyiminizi Geliştiriyoruz

Çerez Tercihleri

Kesinlikle Gerekli Çerezler

Analitik Çerezler