dartdoc
- Dart kursu
- Orta seviye
- Ders 106/116
- 4 dk
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.
Başlangıç kodu
// greet fonksiyonunu ve doc comment'ini yaz
void main() {
// greet('Ayşe') çağrısını yazdır
}Örnek çözüm
/// İsmi selamlar.
String greet(String name) => 'Merhaba $name';
void main() {
print(greet('Ayşe'));
}Beklenen çıktı
Merhaba Ayşe
Soru ve cevaplar
Dersin sorularını cevaplarıyla birlikte inceleyebilirsin. Kendini denemek istersen dersi interaktif olarak çöz.
1 dartdoc ne üretir?
- HTML dokümantasyon Doğru cevap
- Çalıştırılabilir kod
- Test raporu
- Paket dosyası
Açıklama: dartdoc doc comment'lardan HTML sayfalar üretir.
2 dart doc komutu
dart ____ --output build/docsdart doc --output build/docsAçıklama: dart doc dokümantasyon üretir.
3 dartdoc parçaları
| Kavram | Anlamı |
|---|---|
dart doc |
Komut |
/// |
Doc comment |
lib/ |
Taranan klasör |
HTML |
Çıktı biçimi |