İçeriğe geç

Dokümantasyon: JSDoc, Docstring, README

Mevcut kodu dokümante etme: inline doc, README, API docs. ChatGPT ile manuel zaman 10x.

Şükrü Yusuf KAYA
8 dakikalık okuma
Orta
Dokümantasyon: JSDoc, Docstring, README

"Kodu yazmaktan sonra dokümante etmek 2x iş"#

ChatGPT bunu 10x hızlandırır:
  • Inline (JSDoc/docstring) — fonksiyon başına otomatik
  • README — genel kullanım rehberi
  • API docs — endpoint, parametre, örnek
  • Architecture decision records (ADR) — niye bu kararı verdik
Aşağıdaki TypeScript fonksiyonu için tam JSDoc yaz: [Fonksiyon] İçer: - @param her parametre için (type + açıklama) - @returns dönüş açıklaması - @throws atılabilen errorlar - @example minimum 2 farklı kullanım - @see ilgili fonksiyonlar (varsa) Açıklamalar Türkçe; @param tipleri TypeScript syntax.
typescript
/**
* Belirli bir tutar için indirim miktarını hesaplar.
*
* 1000 TL ve üzeri alımlar için %10 indirim uygulanır.
* Negatif tutarlarda ValidationError fırlatılır.
*
* @param amount - İndirimsiz toplam tutar (TL).
* @returns Hesaplanmış indirim miktarı (TL).
* @throws {ValidationError} amount negatif olduğunda.
*
* @example
* // Eşik üstü
* calculateDiscount(1500); // 150
*
* @example
* // Eşik altı
* calculateDiscount(500); // 0
*
* @see {@link calculateFinalPrice}
*/
export function calculateDiscount(amount: number): number {
if (amount < 0) {
throw new ValidationError("Amount must be non-negative");
}
return amount >= 1000 ? amount * 0.1 : 0;
}
ChatGPT'nin ürettiği örnek JSDoc.

Özet#

✓ Dokümantasyon tipleri: inline (JSDoc/docstring), README, API (OpenAPI), ADR ✓ ChatGPT 10x hızlandırır ✓ Hedef: yeni gelen 2 dk'da anlasın
Sıradaki ders: Code Translation — diller arası çeviri.

Yorumlar & Soru-Cevap

(0)
Yorum yazmak için giriş yap.
Yorumlar yükleniyor...

İlgili İçerikler