2017-06-26 31 views
7

Durumum, JavaDocs içermeyen bir üçüncü tarafın harici bir derlenmiş kütüphanesi (jar) var. Gelişmekte olduğum sürece, üçüncü tarafın web sitesinden aldığım çok sınırlı belgeleri test ederek ve kullanarak test ederek sınıfları ve yöntemleri belgelemek istiyorum.Dış kütüphane için JavaDocs yaz

Hedefim, Code-Hinting ve belge araması için IntelliJ'te kullanabileceğim bir JavaDoc belgesine sahip olmak mı?

Sorularım, JavaDocs'ları önceden derleyebildiğim bir jar dosyasına yazabilmem mümkün mü? Belki buna yardımcı olan bir araç kullanıyor olabilirsiniz.

cevap

4

Evet öyle. Yapmanız gereken tek şey, tüm yöntemlerin soyut olduğu gibi, kod ve kodu olmaksızın, sınıf ve arabirim ile yöntem ve değişken tanımlarını yazıp, daha sonra Javadoc yorumları yazabilirsiniz. Bu Güneş teknik yazar ve editörler tarafından kontrol tamamen ayrı bir kaynak ağacının yoluyla, Javadoc üretti aslında nasıl (hi Doug!), Geç kaynak kodunu için inşa sürecinde bir birleştirme işlemi ile.

+0

Hızlı kod örneği gösterebilir misiniz? Cevabınızı daha net hale getirmeye yardımcı olur. onlar soyut sanki – byxor

+0

Sadece 'abstract' anahtar sözcüğü olmadan yerine yöntem gövdesinin yani sadece noktalı virgül yöntemleri yazmak. Bunu derleyemezsin, ama sen de Javadoc yapabilirsin. – EJP

+0

Bu işe yaradı! Bunun için ayrı bir proje hazırladım ve dediğin gibi yaptım. Proje hatalarla dolu olacak, ancak JavaDoc jeneratörü bununla ilgili bir sorun içermiyor. Ana projemde dokümanlar ekledim ve bir cazibe gibi çalıştı. Teşekkür ederim :) – JensV