CodeBlanks Logo Icon CodeBlanks
Giriş Yap Kayıt Ol

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.

Başlangıç kodu

main.dart
// add fonksiyonunu ve doc comment'ini yaz

void main() {
  // add(2, 3) sonucunu yazdır
}

Örnek çözüm

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

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

Beklenen çıktı

5

Soru ve cevaplar

Dersin sorularını cevaplarıyla birlikte inceleyebilirsin. Kendini denemek istersen dersi interaktif olarak çöz.

1 Doc comment işareti

Soru 
/// ____ İsmi selamlar.
Cevap 
/// /// İsmi selamlar.

Açıklama: /// üç tırnak doc comment'tir.

2 Doc comment hangi işaretle başlar?

  • //
  • /// Doğru cevap
  • /*
  • **

Açıklama: /// doc comment, // sıradan yorumdur.

3 Doc comment parçaları

Kavram Anlamı
/// Doc comment
// Normal yorum
[a] Bağlantı
İlk cümle Özet

Orta seviye bölümündeki tüm dersler

1 Sınıflar derinlemesine

  1. Constructor türleri
  2. Named constructor
  3. Initializer list
  4. const constructor
  5. factory
  6. Özet - Sınıflar

2 Kalıtım

  1. extends
  2. super
  3. Override
  4. abstract
  5. interface
  6. Özet - Kalıtım

3 Proje: Yardımcı kütüphane

  1. Modül tasarımı
  2. String yardımcıları
  3. Sayı yardımcıları
  4. Tarih yardımcıları
  5. Birleştirme

4 Kapsülleme

  1. private
  2. Getter ve setter
  3. final ve const alan
  4. late
  5. static
  6. Özet - Kapsülleme

5 Mixin'ler

  1. mixin
  2. mixin kullanımı
  3. mixin kısıtları
  4. Çoklu mixin
  5. mixin vs inheritance
  6. Özet - Mixin'ler

6 Generic'ler

  1. Generic sınıf
  2. Generic metot
  3. Type constraints
  4. Generic collection
  5. Generic vs dynamic
  6. Özet - Generic'ler

7 Proje: Quiz uygulaması

  1. Quiz modeli
  2. Soru ekleme
  3. Quiz oynatma
  4. Skor hesaplama
  5. Birleştirme

8 Koleksiyonlar

  1. List
  2. Set
  3. Map
  4. Queue
  5. Iterable
  6. Özet - Koleksiyonlar

9 Koleksiyon metotları

  1. map
  2. where
  3. fold ve reduce
  4. forEach
  5. any ve every
  6. Özet - Koleksiyon metotları

10 Proje: Kütüphane uygulaması

  1. Model tasarımı
  2. Kütüphane sınıfı
  3. Ödünç verme
  4. Arama ve filtreleme
  5. Birleştirme

11 Async derinlemesine

  1. Future
  2. async/await
  3. Future zincirleme
  4. Future.wait
  5. Completer
  6. Özet - Async

12 Stream'ler

  1. Stream nedir?
  2. Stream dinleme
  3. Stream transformation
  4. asyncExpand
  5. StreamController
  6. Özet - Stream'ler

13 Type alias'lar

  1. typedef
  2. Type alias
  3. Record
  4. Pattern matching
  5. switch expression
  6. Özet - Type alias'lar

14 Metadata ve annotation

  1. Metadata
  2. Özel annotation
  3. @override
  4. @deprecated
  5. Reflection
  6. Özet - Metadata

15 Test

  1. dart test
  2. test ve expect
  3. group
  4. setUp ve tearDown
  5. Mock
  6. Özet - Test

16 Dosya I/O

  1. dart:io
  2. File.readAsString
  3. File.writeAsString
  4. exists
  5. Directory
  6. Özet - Dosya I/O

17 Paketler

  1. pub
  2. pubspec.yaml
  3. pub get
  4. import
  5. pub publish
  6. Özet - Paketler

18 İleri hata yönetimi

  1. Exception hiyerarşisi
  2. Error vs Exception
  3. Stack trace
  4. Result pattern
  5. Async error
  6. Özet - İleri hata yönetimi

19 Dokümantasyon

  1. dartdoc
  2. Doc comments
  3. Markdown
  4. @param ve @return
  5. Örnek kod
  6. Özet - Dokümantasyon

20 Orta seviye finali

  1. Proje tasarımı
  2. OOP modeli
  3. Koleksiyonlar
  4. Dosya I/O
  5. Birleştirme