Java Kodunda Yorumlar Nasıl Kullanılır

Java yorumları, Java kod dosyasındaki derleyici ve çalışma zamanı altyapısı tarafından yok sayılan notlardır. Tasarımını ve amacını açıklığa kavuşturmak için koda açıklama eklemek için kullanılırlar. Bir Java dosyasına sınırsız sayıda yorum ekleyebilirsiniz, ancak yorumları kullanırken izlenecek bazı "en iyi uygulamalar" vardır.

Genel olarak, kod yorumları "uygulama" yorumlarıdır. kaynak kodusınıfların, arabirimlerin, yöntemlerin ve alanların açıklamaları gibi. Bunlar genellikle ne yaptığını açıklığa kavuşturmak için Java kodunun üstünde veya yanında yazılmış birkaç satırdır.

Java yorumunun başka bir türü de Javadoc yorumudur. Javadoc yorumları sözdiziminde uygulama yorumlarından biraz farklıdır ve program javadoc.exe tarafından Java HTML belgeleri oluşturmak için kullanılır.

Kendiniz ve diğer programcılar için okunabilirliğini ve netliğini artırmak için Java yorumlarını kaynak kodunuza koyma alışkanlığına sahip olmak iyi bir uygulamadır. Java kodunun bir bölümünün ne zaman performans gösterdiği her zaman net değildir. Birkaç açıklayıcı kod, kodu anlamak için gereken süreyi büyük ölçüde azaltabilir.

Uygulama yorumları Java kodu sadece insanların okuması için var. Java derleyicileri onları ve ne zaman umurlarında değil programı derlemek, sadece üstlerine atlıyorlar. Derlediğiniz programın boyutu ve etkinliği, kaynak kodunuzdaki yorum sayısından etkilenmeyecektir.

Uygulama yorumları iki farklı biçimde gelir:

• Satır Yorumları: Bir satırlık yorum için "//" yazın ve yorumunuzla birlikte iki eğik çizgiyi izleyin. Örneğin:

   // bu tek satırlık bir yorum
  int guessNumber = (int) (Math.random () * 10); 

  Derleyici iki eğik çizgiyle karşılaştığında, sağlarındaki her şeyin bir yorum olarak kabul edilmesi gerektiğini bilir. Bu, bir kod parçasında hata ayıklarken kullanışlıdır. Hata ayıkladığınız bir kod satırından yorum eklemeniz yeterlidir; derleyici bunu görmez:

  •  // bu tek satırlık bir yorum
    // int guessNumber = (int) (Math.random () * 10); 

    Satır sonu yorumu yapmak için iki eğik çizgiyi de kullanabilirsiniz:

  •  // bu tek satırlık bir yorum
    int guessNumber = (int) (Math.random () * 10); // Satır sonu yorumu 

• Yorumları Engelle: Bir blok yorumu başlatmak için "/ *" yazın. Eğik çizgi ile yıldız işareti arasındaki her şey, farklı bir satırda olsa bile, "* /" karakterleri yorumu bitirene kadar yorum olarak değerlendirilir. Örneğin:

   /* bu 
  dır-dir 
  bir
  blok
  yorum Yap
  */
  /* Öyleyse bu */
  

Java API'nizi belgelemek için özel Javadoc yorumları kullanın. Javadoc, JDK ile birlikte gelen ve kaynak kodundaki yorumlardan HTML belgeleri üreten bir araçtır.

Bir Javadoc yorumu

.java

/**

*/

*

Bu yorumları doğrudan belgelemek istediğiniz yöntemin, sınıfın, yapıcı veya başka bir Java öğesinin üzerine yerleştirin. Örneğin:

// myClass.java
/**
* Bunu sınıfınızı tanımlayan özet bir cümle yapın.
* İşte başka bir satır.
*/
halka açıksınıf sınıfım
{
...
}

Javadoc, belgelerin nasıl oluşturulacağını kontrol eden çeşitli etiketler içerir. Örneğin,

@param

 / ** ana yöntem
* @param args Dize []
*/​
halka açıkstatikgeçersiz main (String [] argümanları)
​{
System.out.println ("Merhaba Dünya!");
}

Javadoc'da birçok başka etiket mevcuttur ve çıktıyı kontrol etmeye yardımcı olmak için HTML etiketlerini de destekler. Daha fazla ayrıntı için Java belgelerinize bakın.

• Yorum yapma. Programınızın her satırının açıklanması gerekmez. Programınız mantıklı bir şekilde akıyorsa ve beklenmedik bir şey olmuyorsa, yorum ekleme gereğini hissetmeyin.
• Yorumlarınızı girintileyin. Yorum yaptığınız kod satırı girintiliyse, yorumunuzun girintiyle eşleştiğinden emin olun.
• Yorumları alakalı tutun. Bazı programcılar kod değiştirmede mükemmeldir, ancak bazı nedenlerden dolayı yorumları güncellemeyi unutun. Bir yorum artık geçerli değilse, değiştirin veya kaldırın.
• Blok yorumları yuvalamayın. Aşağıdakiler derleyici hatasına neden olur:

   /* bu 
  dır-dir
  / * Bu blok yorumu ilk yorumu bitirir * /
  bir
  blok
  yorum Yap
  */