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
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.
"Miscellaneous Unprocessed Files" bölümü javadoc documentation'dan itibaren aradığınız şeydir.
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ı. –
Düzeltme - Tabii ki bir HTML bağlantısı koyabilirsiniz, ancak bağlantılı öğenin taşınması durumunda güncellenmez. –
- 1. Doxygen belgelerine nasıl klasör eklenir?
- 2. Ant build.xml dosyasında dış kütüphaneler nasıl eklenir?
- 3. Moodle - gezinti çubuğunda sayfalar/öğeler nasıl eklenir
- 4. Wildfly'e dış mesajlaşma aracı nasıl eklenir?
- 5. Webpack ile dış dosya nasıl eklenir
- 6. iText - PdfCopy ile oluşturulmuş bir belgeye sayfalar nasıl eklenir
- 7. Java: Timestamp'a saniye nasıl eklenir?
- 8. Java ders notu nasıl eklenir?
- 9. Java - Zamana nasıl sayı eklenir?
- 10. Java - son listeye nasıl eklenir
- 11. Visual C# backtrace: [dış kod] nerede bulunur?
- 12. TruncatedSVD belgelerine
- 13. IntelliJ içinde harici Scala API belgelerine bağlanma
- 14. Visual Studio'nun kod snippet'i: mantık nasıl eklenir?
- 15. Github işaretlemesinde repodan kod nasıl eklenir?
- 16. Scala belgelerine repl'den nasıl erişirim?
- 17. Bir belgeyi java kullanarak bitbucket'e nasıl eklenir?
- 18. Cam kavanoz yapımı işleminde dış kavanozlar nasıl eklenir?
- 19. Moğolda dış arraylist güncellenirken bir iç arraylist değer nasıl eklenir?
- 20. CMake ile CLion C++ projesine dış kitaplık (destek) nasıl eklenir?
- 21. Java SE 5'e javax.annotation.Generated nasıl eklenir?
- 22. Jenkins Workflow'da bir dış kod dosyasını nasıl ekleyebilirim?
- 23. Yönlendirmeler yerine yönlendirmeli sayfalar nasıl yüklenir?
- 24. Java Genel kod
- 25. Java kullanarak mongoDB'ye görüntüler nasıl eklenir?
- 26. Java Vaadin'deki optionsGroup seçeneklerine dinleyici nasıl eklenir?
- 27. Apache Commons IO Eclipse'e nasıl eklenir? (Java)
- 28. netbeans Java projesine nasıl resim eklenir
- 29. Java kullanarak Mongodb'da yinelenen veriler nasıl eklenir?
- 30. Java regex'te adlandırılmış yakalama grupları nasıl eklenir?
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? –
Evet, bence bu bir hata olur. Kaynak kodunuzu dokümantasyon için kirletmeyin! :) –
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? –