Java Yorumlar, bir programdaki derleyici ve yorumlayıcı tarafından yürütülmeyen ifadelerdir.
Neden bir kodda yorumları kullanıyoruz?
- Yorumlar, kodun ayrıntılarını ekleyerek programı daha okunaklı hale getirmek için kullanılır.
- Kodun bakımını ve hataların kolayca bulunmasını kolaylaştırır.
- Yorumlar, konu hakkında bilgi veya açıklama sağlamak için kullanılabilir. değişken , yöntem, sınıf veya herhangi bir beyan.
- Alternatif kodu test ederken program kodunun yürütülmesini önlemek için de kullanılabilir.
Java Yorum Türleri
Java'da üç tür yorum vardır.
- Tek Satır Yorum
- Çok Satırlı Yorum
- Dokümantasyon Yorumu
1) Java Tek Satır Yorumu
Tek satırlık yorum, kodun yalnızca bir satırını yorumlamak için kullanılır. İfadeleri yorumlamanın en yaygın ve en kolay yoludur.
Tek satırlık yorumlar iki eğik çizgiyle başlar (//) . // önündeki herhangi bir metin Java tarafından yürütülmez.
Sözdizimi:
//This is single line comment
Bir Java programında tek satırlık yorum kullanalım.
YorumÖrnek1.java
public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } }
Çıktı:
10
2) Java Çok Satırlı Yorum
Çok satırlı yorum, birden fazla kod satırına yorum yapmak için kullanılır. Karmaşık bir kod parçacığını açıklamak veya aynı anda birden fazla kod satırına yorum yapmak için kullanılabilir (çünkü burada tek satırlık yorumları kullanmak zor olacaktır).
Çok satırlı açıklamalar /* ile */ arasına yerleştirilir. /* ile */ arasındaki herhangi bir metin Java tarafından yürütülmez.
Sözdizimi:
gigabayt ile megabayt arasındaki fark
/* This is multi line comment */
Bir Java programında çok satırlı yorumu kullanalım.
YorumÖrnek2.java
public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } }
Çıktı:
10
Not: Genellikle kısa yorumlar için // kullanılır ve daha uzun yorumlar için /* */ kullanılır.
3) Java Belgelendirme Yorumu
Dokümantasyon yorumları genellikle bir proje veya yazılım uygulaması için büyük programlar yazmak için kullanılır, çünkü dokümantasyon API'sinin oluşturulmasına yardımcı olur. Bu API'ler referans için gereklidir, yani kodda hangi sınıfların, yöntemlerin, argümanların vb. kullanıldığı.
Dokümantasyon API'sini oluşturmak için şunu kullanmamız gerekir: javadoc aracı . Dokümantasyon yorumları /** ve */ arasına yerleştirilir.
Sözdizimi:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc etiketleri
Belge yorumlarında yaygın olarak kullanılan etiketlerden bazıları:
Etiket | Sözdizimi | Tanım |
---|---|---|
{@docRoot} | {@docRoot} | herhangi bir sayfadan oluşturulan belgenin kök dizinine giden göreceli yolu göstermek için. |
@yazar | @yazar adı - metin | Sınıfın yazarını eklemek için. |
@kod | {@kod metni} | Metni, html işaretlemesi veya iç içe javadoc etiketi olarak yorumlamadan kod yazı tipinde göstermek için. |
@sürüm | @version sürüm metni | -version seçeneği kullanıldığında 'Sürüm' alt başlığını ve sürüm metnini belirtmek için. |
@o zamandan beri | @yayınlanmasından bu yana | Oluşturulan belgelere o zamandan bu yana metin içeren 'Bundan beri' başlığını eklemek için. |
@param | @param parametre adı açıklaması | 'Parametreler' bölümüne verilen ad ve açıklamayla bir parametre eklemek için. |
@geri dönmek | @dönüş açıklaması | Bir şey döndüren her yöntem için gereklidir (geçersiz hariç) |
Javadoc etiketini bir Java programında kullanalım.
Hesapla.java
import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println('Addition of numbers: ' + result); } } </p>
Javac aracıyla derleyin:
Belge Oluştur
Şuna göre dokümantasyon API'si oluşturun: javadoc alet:
Artık HTML dosyaları şu amaçlar için oluşturulmuştur: Hesaplamak geçerli dizindeki sınıf, yani, abcDemo . HTML dosyalarını açın ve belge yorumu aracılığıyla sağlanan Calculate sınıfının açıklamasını görebiliriz.
Java yorumları çalıştırılabilir mi?
Yıllar: Bildiğimiz gibi Java yorumları derleyici veya yorumlayıcı tarafından yürütülmez, ancak derleyicide kodun sözcüksel dönüşümünden önce, işlemi kolaylaştırmak için kodun içeriği ASCII'ye kodlanır.
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } }
Çıktı:
Yukarıdaki kod, derleyici Unicode karakterini ayrıştırdığı için çıktı üretir u000d olarak Yeni hat sözcüksel dönüşümden önce ve böylece kod aşağıda gösterildiği gibi dönüştürülür:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } }
Böylece Unicode karakteri, print ifadesini bir sonraki satıra kaydırır ve normal bir Java kodu gibi yürütülür.