Java'da yorumlar, kodu açıklayan ve okunabilirliği artıran yürütülemeyen ifadelerdir. Derleyici tarafından göz ardı edilirler ve programın yürütülmesini etkilemezler.
- Kodun okunabilirliğini ve sürdürülebilirliğini geliştirin.
- Mantığı ayıklamak ve belgelemek için kullanışlıdır.
Java üç ana yorum türünü destekler:
1. Tek Satırlı Yorumlar
Tek satırlık yorumlar, bir kod satırına yorum yapmak için kullanılır.
Sözdizimi:
Java// Yorumlar buraya (Bu satırdaki metinler yalnızca yorum olarak kabul edilir)
// Java program to show single line comments class GFG { public static void main(String args[]) { // Single line comment here System.out.println('Single Line Comment Above'); } }
Çıkış
Single Line Comment Above
2. Çok Satırlı Yorumlar
Çok satırlı yorumlar, karmaşık kodu veya yöntemleri tanımlamak için kullanılır, çünkü birden çok tek satırlı yorum yazmak sıkıcı olabilir.
Java/*
Yorum başlangıcı
devam ediyor
devam ediyor...
Yorum biter
*/
class GFG { public static void main(String args[]) { System.out.println('Multi Line Comments Below'); /* Comment line 1 Comment line 2 Comment line 3 */ } }
Çıkış
Multi Line Comments Below
3. Dokümantasyon Açıklamaları
Belge yorumları Javadoc kullanarak harici belgeler oluşturmak için kullanılır. Genellikle profesyonel projelerde sınıf yöntemlerini ve parametrelerini tanımlamak için kullanılırlar.
Sözdizimi:
Java/**
* Yorum başlangıcı
* @param parametre adı açıklaması
* @dönüş açıklaması
*/
/** * * Calculates the average of three integers. * @author Pratik Agarwal * @version 1.0 * @since 2017-02-18 */ public class FindAvg{ /** * Finds average of three integers. * @param numA First parameter * @param numB Second parameter * @param numC Third parameter * @return Average of numA numB and numC */ public int findAvg(int numA int numB int numC) { return (numA + numB + numC) / 3; } /** * Main method which uses findAvg method * @param args Unused */ public static void main(String args[]){ FindAvg obj = new FindAvg(); int avg = obj.findAvg(10 20 30); System.out.println('Average of 10 20 and 30 is: ' + avg); } }
Çıkış
Average of 10 20 and 30 is: 20
İlgili Makale: JavaDoc aracı
gigabayt ile megabayt arasındaki fark