2009-03-09 19 views
4

C++ ile programlama yaparken, Doxygen kullanıyor ve belirli bir sınıfa veya yönteme uymayan ek belgeler için sık sık harici .dox dosyaları oluşturuyoruz - örneğin, dosya biçimi belgeleri (birden çok sınıf tarafından erişilen dosyalar için). Java'da aynısını yapmanın bir yolunu bulmaya çalıştım ama javadoc'un eşdeğer bir özelliği olmadığını, tüm belgelerin bir .java dosyasının yorumlarının içine yazılması gerektiğini ve ona bağlı olduğunu (veya en azından onun paketi). Ben haklı mıyım Bunu yapmanın alternatif bir yolu var mı?Java kod belgelerine dış sayfalar nasıl eklenir?

cevap

2

Javadoc'un harici belgeler oluşturup oluşturamayacağını soruyorsanız, yanıt hayır olur. Ancak, daha önce yaptığınız dış belgelere bağlantı sağlayabilirsiniz. Ayrıca, paket seviyesinde bir şey varsa, belgeleri belirli bir sınıfa veya yönteme eklemek yerine paket dosyasına koyabilirsiniz.

+0

Sadece bu tür bilgileri içerecek bir paket ve sınıflar oluşturma hakkında ne düşünüyorsunuz (yani, herkes tarafından kullanılmayan boş sınıflar, yalnızca bu belgeleri yerleştirmek için bir yer). Çok çirkin olur mu? –

+0

Evet, bence bu bir hata olur. Kaynak kodunuzu dokümantasyon için kirletmeyin! :) –

+0

Bir yorum dosyası alır bir komut dosyası hakkında - bir .jdoc diyelim, bir stub boş sınıf ile temp .java dosyasında sarar, javadoc derleyici çalışır ve geçici dosyayı siler? –

4

"Miscellaneous Unprocessed Files" bölümü javadoc documentation'dan itibaren aradığınız şeydir.

+0

Teşekkürler, MUF hakkında bir şeyler biliyordum ama biraz farklı bir şey arıyordum. Benim özlediğim şey, Doxygen için bir .dox dosyası oluştururken, aynı sözdizimini (@view, @version, vb. Koyabilirsiniz) .doks'un içine/bağlantısını ve statik bir HTML ile mümkün olmazdı. –

+0

Düzeltme - Tabii ki bir HTML bağlantısı koyabilirsiniz, ancak bağlantılı öğenin taşınması durumunda güncellenmez. –

İlgili konular