@param ne demek?

@param, özellikle programlama dillerinde ve dokümantasyon araçlarında kullanılan bir etikettir. Bir fonksiyon, metot veya prosedürün parametrelerini tanımlamak ve belgelemek için kullanılır.

Temel İşlevi:

• Parametre Tanımlama: Bir fonksiyonun hangi parametreleri aldığını belirtir.
• Veri Tipi Belirleme: Parametrenin hangi veri tipinde (örneğin, sayı, metin, boolean) olması gerektiğini gösterir.
• Açıklama Ekleme: Parametrenin ne işe yaradığını, nasıl kullanılması gerektiğini veya beklenen değer aralığını açıklayan bir metin eklenmesini sağlar.

Kullanım Şekli:

Genellikle, @param etiketi bir yorum bloğu içinde yer alır ve şu şekilde kullanılır:

/**
 * Açıklama: Bu fonksiyon iki sayıyı toplar.
 * @param {number} a - Toplanacak ilk sayı. ([https://www.nedemek.page/kavramlar/veri%20tipi](https://www.nedemek.page/kavramlar/veri%20tipi))
 * @param {number} b - Toplanacak ikinci sayı. ([https://www.nedemek.page/kavramlar/sayı](https://www.nedemek.page/kavramlar/sayı))
 * @returns {number} İki sayının toplamı.
 */
function topla(a, b) {
  return a + b;
}

Bu örnekte:

• @param {number} a ifadesi, a adında bir parametre olduğunu ve bu parametrenin sayı türünde olduğunu belirtir.
• - Toplanacak ilk sayı. kısmı ise bu parametrenin ne işe yaradığını açıklar.
• @returns {number} ifadesi, fonksiyonun geriye bir sayı değeri döndürdüğünü gösterir.

Faydaları:

• Dokümantasyon Oluşturma: Kodun otomatik olarak dokümante edilmesini sağlar. Bu, kodun okunabilirliğini ve anlaşılabilirliğini artırır.
• Kod Tamamlama: IDE'ler ve kod düzenleyiciler, @param etiketlerini kullanarak kod tamamlama önerileri sunabilir.
• Hata Tespiti: Bazı araçlar, @param etiketlerinde belirtilen veri tipleriyle fonksiyon çağrısındaki parametrelerin uyumlu olup olmadığını kontrol ederek hataları önleyebilir.

Özetle, @param etiketi, kodun daha iyi belgelenmesine, anlaşılmasına ve sürdürülebilirliğine katkıda bulunan önemli bir araçtır.