Spring框架和html / xml文件上的Javadoc示例/模板

时间:2018-10-10 11:44:11

标签: java spring documentation javadoc

现在在Eclipse中使用Spring Framework从事J2EE项目。我们想用Javadoc编写源文档,并有以下问题:1)由于Spring框架使用了很多注释并且对于新手来说很难遵循,因此任何文档模板/指南都可以编写源文档,以便其更容易让新手跟随?

2)除了.java文件之外,我们的项目还涉及许多html(带有Thymeleaf)和xml文件,因此我们也希望为这些html / xml文件生成doc(persistence.xml中的许多设置很困难如果没有记录,将在2周后继续执行)是否有JavaDoc支持这些html / xml文件的方法?

3)如果不使用JavaDoc将Eclipse中的任何其他组件用作文档?

谢谢。

林志峰

1 个答案:

答案 0 :(得分:0)

我认为您不仅需要JavaDoc,还请看看AsciiDoc及其扩展名。

相关问题