Özet - Dokümantasyon

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.

Örnek çözümü göster

/// Tabanı kendisiyle çarpar.
/// [base] karesi döner.
int power(int base) => base * base;

void main() {
  print(power(6));
}

Kendini test et

Dart'ta parametre referansı nasıl yazılır?
- @param name
- [name]
- $name
- &name
Cevabı göster

[name] — [name] köşeli parantez parametre bağlantısı verir.
Dokümantasyon özet

dart doc

HTML üretir
///

Doc comment
[name]

Parametre
```dart

Kod bloğu
Örnek kod bloğu
```
/// ____dart
```
Cevabı göster
```
/// ```dart
```

Sıradaki ders: Proje tasarımı

Deneyiminizi Geliştiriyoruz

Çerez Tercihleri

Kesinlikle Gerekli Çerezler

Analitik Çerezler