Özet - Dokümantasyon
- Dart kursu
- Orta seviye
- Ders 111/116
- 5 dk
dartdoc, /// ve Markdown'ı birleştirerek bir dokümante kütüphane yazarsın.
Özet - Dokümantasyon
Bu grupta Dart dokümantasyonunu öğrendin: dartdoc, /// doc comment'lar, Markdown, [name] referansları ve örnek kod blokları.
Özet: dart doc HTML üretir; /// ile doc comment yazılır; Markdown ile zengin biçim; [name] ile parametre bağlantısı; ```dart ile örnek kod.
İyi belge, kısa ilk cümle, doğru parametre bağlantıları ve çalışan örnek kod ister; aşırı biçimden kaçınılır.
Birleşik örnek
Tüm kavramları birleştiren bir doc comment: /// Tabanı kendisiyle çarpar. altına /// [base] karesi döner. ve ister bir örnek blok eklersin.
Sonra fonksiyon: int power(int base) => base * base;. dartdoc bu yorumdan özet, parametre bağlantısı ve örnek üretir.
Bu kalıp, paketindeki her public API için tekrarlanır; tutarlı belgeler verir.
Uygulama Dokümante edilmiş fonksiyon
int power(int base) => base * base; fonksiyonunu yaz. Üzerine iki satır doc comment ekle: birinci satır /// Tabanı kendisiyle çarpar., ikinci satır /// [base] karesi döner.. main içinde print(power(6)) çağır.
Başlangıç kodu
// power fonksiyonunu ve doc comment'ini yaz
void main() {
// power(6) sonucunu yazdır
}Örnek çözüm
/// Tabanı kendisiyle çarpar.
/// [base] karesi döner.
int power(int base) => base * base;
void main() {
print(power(6));
}Beklenen çıktı
36
Soru ve cevaplar
Dersin sorularını cevaplarıyla birlikte inceleyebilirsin. Kendini denemek istersen dersi interaktif olarak çöz.
1 Dart'ta parametre referansı nasıl yazılır?
- @param name
- [name] Doğru cevap
- $name
- &name
Açıklama: [name] köşeli parantez parametre bağlantısı verir.
2 Dokümantasyon özet
| Kavram | Anlamı |
|---|---|
dart doc |
HTML üretir |
/// |
Doc comment |
[name] |
Parametre |
```dart |
Kod bloğu |
3 Örnek kod bloğu
/// ____dart/// ```dartAçıklama: ```dart kod bloğunu açar.