Şimdi Ara

Javadoc yorumları kullanmalı mıyım?

Daha Fazla
Bu Konudaki Kullanıcılar: Daha Az
2 Misafir - 2 Masaüstü
5 sn
5
Cevap
0
Favori
458
Tıklama
Daha Fazla
İstatistik
  • Konu İstatistikleri Yükleniyor
Öne Çıkar
0 oy
Sayfa: 1
Giriş
Mesaj
  • Merhaba.

    Bir oyun yapmaya çalışıyorum, fakat oyunu her biraz daha geliştirdiğimde dosya sayısı ve kod sayısı biraz daha artıyor. Daha sonralar kullandığım IDE'de mavi yorumlarla metotlara, sınıflara, değişkenlere vb. şeylere açıklamalar, geriye döndürülen değerler, fırlatılan istisnalar gibi şeyler eklenebileceğini gördüm.
    Mavi yorum dediğim şeyi bir örnek metotla göstermek istiyorum:
     
    /**
    * İkiden çok sayıları toplamak için bu metot kullanılabilir.
    *
    * @author FalanFilan Şirketi
    *
    * @param sayilar - Toplanacak sayılar dizisi.
    *
    * @return Dizideki tüm sayıların toplamı geriye int şeklinde döndürülür.
    *
    * @throw - Fırlatılan bir istisna yok.
    */
    public static int topla(int[] sayilar) {
    . . .
    }

    Sizce bunları kullanmalı mıyım? Yoksa bunlar programda kalabalık yapıp gözümü yorar mı? Tavsiyelerinizi bekliyorum .







  • yazmak şart değil. ancak uzun bir süre geçtikten sonra kendi kodlarını bile anlamakta zorluk çekeceksin.
    açıklamalar kodları okuyanlar için faydalı olacaktır.
    _____________________________
    Mesut Akcan | YouTube kanalım | Blog sayfam
  • javaDoc yorumlarını hazırladıktan sonra, javaDoc belgelendirme sayfaları oluşturabiliyorsun. Bu da çok güzel bir şey özellikle birden fazla kişiyle çalışılıyorsa, açık kaynak bir proje, dağıtılacak bir kütüphane ise... Yine bu javaDoc'ları yazdığın zaman NetBeans, Eclipse gibi IDE'ler metodları çağırırken bu açıklamaları getiriyorlar otomatik tamamlama kısmında.

    Daha önce karşılaşmışsındır mutlaka. Ancak yine de bazı örnekler vereyim.
    http://slick.ninjacave.com/javadoc/overview-summary.html
    http://slick.ninjacave.com/javadoc/org/newdawn/slick/AppGameContainer.html
    http://weblookandfeel.com/javadoc/com/alee/examples/groups/optionpane/ConfirmOptionPaneExample.html
    _____________________________

    "The first lesson of economics is scarcity: There is never enough of anything to satisfy all those who want it."
    "The first lesson of politics is to disregard the first lesson of economics."

    "Underlying most arguments against the free market is a lack of belief in freedom itself."
    "What is your 'fair share' of what someone else has worked for?"




  • Eger yazdigin kodu disari acacaksan, open source bir seyler yapiyor ya da API gelistiriyorsan bu yorumlar onemlidir. Ancak yazilan kod, kendi kendini anlatabilecek kadar acik olmalidir. Bazen karmasik algoritmalar implemente ettiginde ( ki karmasik olmamali, metodlar parcalanarak okunabilir hale getirilmeli ) tek satirlik aciklayici bir comment yazmak uzun carsaf gibi commentlerden cok daha yararli. Gecen gun bir ecommerce projesinde suna benzer bir kod blogu gordum:
     
    void calculateTotalPrice()

    void calculateFinalPrice()

    void calculatePriceIncludingShipping()


    void calculateCustomerTotalPrice()

    // Musterinin odedigi toplam fiyat icin bu metodu kullanin
    void calculateBasketTotalPrice()





    orada gordugun tek satirlik comment sayesinde 2 saat zaman kazandim. Ancak yine de ayni isi yapan farkli metodlarin teklenmesi, obsolete metodlarin silinmesi, kodun kendi kendini ifade edecek hale getirilmesi gerekiyor. Yani bu kadar benzer isimde metod olmasa, o commete de gerek kalmayacak. Da Vinci'nin bir sozu var " Simplicity is the ultimate sophistication. "
    _____________________________




  • Yorumlarınız için teşekkürler . Tek satırlık yorumlar daha kullanışlı görünüyor.
  • Yapay Zeka’dan İlgili Konular
    Arch Linux Kullanmalı mıyım?
    6 yıl önce açıldı
    Daha Fazla Göster
    
Sayfa: 1
- x
Bildirim
mesajınız kopyalandı (ctrl+v) yapıştırmak istediğiniz yere yapıştırabilirsiniz.