Javadoc içeren bir kaynak dosya iyi bir örnek var mı?
İnternette Javadoc'un birçok iyi örneğini bulabilirim, sadece onları oluşturmak için kullanılan belirli sözdizimini bulmak istiyorum ve bir yerlerde bazı kütüphanelerin kaynağına göz atabileceğimi varsayıyorum, ancak bu çok fazla iş gibi görünüyor.
Yanıtlar:
JDK kaynak koduna bakalım, ancak docjar gibi bir üçüncü taraf aracılığıyla erişildi mi? Örneğin, Koleksiyonlar kaynağı .
Bu şekilde, büyük bir indirme yoktur.
src.zipstandart kitaplıkların kaynak kodunu içeren bir dosya içerir .
Javadoc Aracı için Doc Coments Nasıl Yazılır sayfası , çok sayıda iyi örnek içerir. Bir bölüme Doküman Yorumlarına Örnekler denir ve oldukça az sayıda kullanım içerir.
Ayrıca, Javadoc SSS , yanıtları göstermek için bazı örnekler de içerir.
JDK kaynak koduna ne dersiniz ?
Küçük bir dokümantasyon kalıbı seti kullanıyorum:
Bahar çerçeve kaynağına bir göz atın, mükemmel javadoclara sahiptir
Örneğin ANT - kaynak kodu çevrimiçi olarak göz atılabilir: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co
Diğer dosyaları seçmek için şu adresten başlayın: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528
Lucene kaynaklarını indirin ve nasıl yaptıklarını görün. İyi JavaDoc'ları var.
Eğer kullanıyorsanız Eclipse , o zaman kurulum yapabilirsiniz JDK (değil JRE olarak) Yüklü JRE sonra ve kullanımı Açık Tipi ( Ctrl+ Shift+ T), vermek gibi bir şeyjava.util.Collections
Google Guava'nın EventBus paketi ve sınıflarının belgeleri Javadoc'a iyi bir örnektir. Özellikle hızlı başlangıçlı paket belgeleri iyi yazılmıştır.
Bir JDK yükler ve kaynakları da yüklemeyi seçerseniz, src.zip TÜM ortak Java sınıflarının kaynağını içerir. Bunların çoğunda oldukça iyi javadok var.
Tüm aradığınız sözdizimi ise, bu yardımcı olabilir: