@return ne demek?

@return etiketi, genellikle programlama dillerinde ve özellikle de belgeleme (documentation) araçları tarafından kullanılan bir Javadoc etiketidir. Bir fonksiyonun veya metodun ne tür bir değeri döndürdüğünü veya ne döndüreceğini belirtmek için kullanılır.

Kullanım amacı:

• Döndürülen değerin türünü belirtmek: @return etiketi, fonksiyonun veya metodun hangi veri tipinde bir değer döndürdüğünü açıkça belirtir. Örneğin, bir fonksiyonun int (tamsayı), string (metin), boolean (doğru/yanlış) veya bir nesne döndürdüğünü ifade edebilir.
• Döndürülen değerin anlamını açıklamak: Sadece türünü belirtmekle kalmaz, aynı zamanda döndürülen değerin ne anlama geldiğini veya hangi koşullarda hangi değerin döndürüldüğünü de açıklayabilir. Bu, fonksiyonu kullanan geliştiricilerin, fonksiyonun nasıl çalıştığını ve ne beklemeleri gerektiğini anlamalarına yardımcı olur.
• Otomatik belgeleme araçları: @return etiketi, otomatik belgeleme araçları tarafından (örneğin, Javadoc, Doxygen, Sphinx) kod dokümantasyonunu oluşturmak için kullanılır. Bu araçlar, kod içindeki bu etiketleri okuyarak, fonksiyonların ve metotların açıklamalarını otomatik olarak oluşturabilirler. Bu, dokümantasyon sürecini kolaylaştırır ve kodun daha iyi anlaşılmasına katkıda bulunur.

Örnek:

/**
 * İki sayının toplamını hesaplar.
 *
 * @param a İlk sayı.
 * @param b İkinci sayı.
 * @return İki sayının toplamı.
 */
public int topla(int a, int b) {
    return a + b;
}

Bu örnekte, @return etiketi, topla fonksiyonunun iki tamsayıyı toplayıp, sonucu (yine bir tamsayı) döndürdüğünü açıkça belirtmektedir. Bu, fonksiyonu kullanan bir geliştiriciye, fonksiyonun ne yaptığını ve ne tür bir sonuç bekleyebileceğini kolayca anlamasına yardımcı olur.