JSDoc, JavaScript için güçlü bir dokümantasyon oluşturucusudur. Kodunuz için ayrıntılı API dokümantasyonu oluşturmak üzere özel olarak biçimlendirilmiş yorumlar kullanır. JavaScript dosyalarınıza JSDoc yorumları ekleyerek, işlevleriniz, sınıflarınız ve modülleriniz hakkında net ve yapılandırılmış bilgiler sağlayabilirsiniz.
JSDoc'un temel özellikleri:
Tür bilgisi
İşlev parametreleri ve dönüş değerleri
Sınıf ve yöntem açıklamaları
Modül dokümantasyonu
JSDoc'taki özellikle yararlı bir etiket @example etiketidir. Bu etiket, dokümantasyonunuza kod örnekleri eklemenizi sağlar. Aracımızı farklı kılan şey, @example etiketi içindeki biçimlendirmeyi, girintiyi ve satır sonlarını koruma yeteneğidir. Bu, daha okunabilir ve gerçekçi kod örnekleri yazabileceğiniz ve geliştiricilerin işlevlerinizi veya sınıflarınızı nasıl kullanacaklarını anlamalarını kolaylaştırabileceğiniz anlamına gelir.
Örnek kullanım:
/**
* Calculates the sum of two numbers.
* @param {number} a - The first number.
* @param {number} b - The second number.
* @returns {number} The sum of a and b.
* @example
* // This example preserves formatting and line breaks
* const result = add(5, 3);
* console.log(result);
* // Output: 8
*/
function add(a, b) {
return a + b;
}
Çevrimiçi JSDoc yorum oluşturucumuzu kullanarak, kod örneklerinizde korunan biçimlendirmeyi içeren, iyi biçimlendirilmiş belgeleri kolayca oluşturabilir, JavaScript belgelerinizi daha açık ve etkili hale getirebilirsiniz.