Bu yazımda Java comment line (yorum satırı) nedir sorusunun cevabını vereceğim. Ayrıca comment line oluşturma yöntemlerini de kod üzerinde göstereceğim. Yazının içeriği aşağıdadır.
İçindekiler
- Comment Line Nedir?
- Comment Line Oluşturma Yöntemleri
Dilerseniz Comment Line nedir ve ne işe yarar? sorusunun cevabı ile başlayalım.
Comment Line (Yorum Satırı) Nedir?
Java’da comment line yani yorum satırları, kodun anlaşılmasını kolaylaştırmak, açıklama eklemek veya belirli bir kod parçasını devre dışı bırakmak için kullanılan metinsel açıklamalardır.
Yorum satırları, derleyici tarafından görmezden gelinir ve programın çalışması üzerinde herhangi bir etkisi yoktur. Sadece kodun anlaşılmasına ve belgelenmesine katkıda bulunurlar.
Peki neden Comment Line kullanmaya ihtiyaç duyuyoruz?
⇒ Koda ayrıntılar ekleyerek programı daha okunabilir yapar.
⇒ Variables (değişkenler), Metod’lar ve Class’lar hakkında bilgi veya açıklamalar eklenebilir.
⇒ Alternatif olarak yazılan kodu test ederken programın kodu çalıştırmasını engellemek için kullanılabilir.
Ayırca yorum satırları programcıların birbirleriyle iletişim kurması için kullanılan bir yoldur. Büyük projelerde pek çok programcı aynı anda çalışabilir yada sizin yazdığınız kodu başkasının tamamlaması gerekebilir. Böyle durumlarda kod içine eklenen yorum satırları ile kodunuzu inceleyen yada tamamlayacak kişiye bilgiler verebilirsiniz.
İsterseniz yorum satırları hakkında bu kadar teorik bilgiden sonra bir de nasıl oluştururuz sorusunun cevabına göz atalım.
Comment Line (Yorum Satırı) Oluşturma Yöntemleri
Comment Line oluşturmak için bir kaç farklı yöntem bulunmaktadır. Bunlar:
⇒ Java’da Single Line (Tek Satırlık) Comment Line
“//” işaretiyle başlar ve o satırın sonuna kadar devam eder. Örneğin:
|
1 2 3 4 5 6 7 |
// Bu bir yorum satırıdır. Bu satır kodu etkilemez. int x = 10; // Bu da bir yorum satırıdır. Bu satırda bir değişken tanımlanır. // İşte bir daha yorum satırı. |
⇒ Java’da Multi Line (Çok Satırlı) Comment Line
“/*” işareti ile başlar ve “*/” ile biter. Arada kalan tüm satırlar yorum satırı olarak kabul edilir.
Örneğin;
|
1 2 3 4 5 6 7 8 9 |
/* Bu bir çok satırlı yorumdur. */ |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
public class CommentLineExample { public static void main(String[] args) { /* Hadi Java'da çok satırlı bir Comment Line oluşturalım. */ int i=2; System.out.println(i); /* double j = 5.92; float k = 4.4; System.out.println( j + k ); */ } } |
⇒ Java’da Documentation Comments
Java’da Documentation Comment (Belgeleme yorumları) dediğimiz yöntem ise, programcıların kodlarını belgelemek ve otomatik API belgeleri oluşturmak için kullanılan özel bir yorumlama metodudur. Bu yorumlar, Java’nın belgeleme aracı olan Javadoc tarafından tanınır ve işlenir.
Documentation Comment’i, sınıflar, yöntemler, değişkenler ve paketler gibi program unsurlarıyla ilgili ayrıntılı açıklamalar sağlamak için kullanıyoruz.
Java’da belgeleme yorumları “/**” ile başlar ve “*/” ile biter. Aşağıda bir örnek gösterilmiştir:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
/** * Bu bir belgeleme yorumudur. Bu yorumda sınıfın amacı ve kullanımı hakkında bilgi verilebilir. * Ayrıca, sınıfın özellikleri ve yöntemleri için ayrıntılı açıklamalar da yapılabilir. */ public class MyClass { /** * Bu bir belgeleme yorumudur. Bu yorumda değişkenin amacı ve kullanımı hakkında bilgi verilebilir. */ private int myVariable; /** * Bu bir belgeleme yorumudur. Bu yorumda yöntemin amacı, parametreleri, dönüş değeri ve kullanımı hakkında bilgi verilebilir. * @param param1 Bu parametre ... * @param param2 Bu parametre ... * @return Bu yöntem ... */ public int myMethod(int param1, String param2) { // Yöntemin kodu burada yer alır } } |
Documentation Comment, Javadoc tarafından işlenerek HTML veya diğer belgeleme formatlarına dönüştürülür. Bu belgeler, kodun kullanıcılara ve diğer geliştiricilere API’yi nasıl kullanacaklarını ve anlayacaklarını açıklayan kapsamlı bir referans sağlıyor.
Ayrıca IDE’ler tarafından otomatik tamamlama ve belge görüntüleme gibi özellikler için de Comment Line kullanıyoruz.
Bu yazımda Java Comment Line (Yorum Satırı) hakkında merak edilen soruları cevapladım. Bu yazı ve bundan önceki yazıları iyi anladığınızı düşünüyorsanız bir sonra ki yazıya geçmeye hazırsınız.
Eğer şimdiye kadar olan yazılarda anlamadığınız yada bilgi sahibi olmadığınız kısımlar varsa Java Projesi Oluşturma, Java Console Çıktısı Alma yazılarına göz atmanızı tavsiye ederim.
Umarım sizler için faydalı bir yazı olmuştur.
Happy Coding!
 Kullanımı){kind=link}