MD Formatında Javascript Kod Dökümantasyonu – JSDoc2md

JSDoc, javascript kodlarınıza eklenen yorumları kompile ederek, HTML halinde sayfalar şeklinde dökümantasyona çeviren güzel bir konsol uygulaması.

Bunun yanında, JSDoc2MD isimli ve yine JSDoc üzerine oluşturulmuş bir diğer güzel uygulama ile, kodlarınızın dökümantasyonunu tek sayfa halinde md formatında çıktı olarak da alabiliyorsunuz.

jsdoc-to-markdown @Github

Uygulamayı npm üzerinden yükledikten sonra;

npm install jsdoc-to-markdown

Fonksiyon ve class'larınız için çalışma ve kullanım talimatlarını @param ve @returns ile belirleyin;

/**
Iki sayiyi toplayan bir fonksiyon
@param {number} - operator 1
@param {number} - operator 2
@returns {number} - sonuc
*/
function toplam(nm1, nm2){}

Son olarak istediğiniz zaman javascript kod dökümanınızı md olarak konsoldan şu komut ile alabilirsiniz;

jsdoc2md dosya/yolu/dosya.js > api.md

Burada dökümanlar, api.md dosyasına çıktı olarak kayıt edilecek.

Birden fazla dosyayı da aynı anda okuyarak çıktı da alabilirsiniz;

jsdoc2md dosya/**/*.js > api.md

Bu komut ile dosya klasörü içinde bulunan tüm alt klasörlerin içindeki .js dosyaları taranacak.

Ayrıca bu kodu package.json üzerinde npm için bir kısayol olarak atayabilirsiniz;

{
  "scripts": {
    "docs": "jsdoc2md lib/*.js > api.md"
  }
}
...
npm run docs

Veya build aldığınız kısa komut için de bu komutu linkleyerek, her build aldığınızda api.md dosyasının güncellenmesini sağlayabilirsiniz.

Alt Text

Örnek olarak şu proje üzerinde README.md dosyasında bir örnek görebilirsiniz;

otsimo/aac @Github

Yorumları Göster veya Yeni Yorum Yaz