Question

我需要在java + jsp中记录一个（相当）大项目（1.0 ......不要让我开始）。

对于中间层（所有.java类），我只使用doxygen生成.html和.pdf文档，但我的负责人要求我记录并集成.jsp页面的文档。

AFAIK不是doxygen也不是javadoc直接适合这项工作。我错了吗？

我能想到的唯一方法是在jsp页面中插入<%/** javadoc-style comments */%>，然后在.java文件中编译.jsp，然后应用doxygen ......但它有点过于复杂......

Answer 1

JspDoc仅为此创建

jspDoc能够浏览jsp的集合。原理与JavaDoc非常相似，你可以在每个jsp中添加一个注释部分，如：

<% /**
<doc>
<name>directory2.jsp</name>
<category>System</category>
<summary>List all jsp files with category and summary</summary>
<history><date>10/08/01 us</date> Gilbert Brault 
<action> creation</action>
</history>
<history><date>10/25/01 us</date> Gilbert Brault 
<action> adapted pharos:foreach switch itCounter to Integer (was int before)</action>
</history>
<outline>
<ul>
<li>if refresh set or new session, list all jsp files of the server and parse them</li>
<li>List files according to the following criteria
<ul>
<li>creation order (item #) column</li>
<li>file name (no case sensitive)</li>
<li>category of processing</li>
</ul>
</li>
</ul>
</outline>
<todo>
<ul>
<li>display modification date and allow ordering by dates</li>
</ul>
</todo>
<copyright>Schneider-Electric 2001</copyright>
</doc>
*/

并且您可以使用三种服务浏览此集合： - 目录 - ＆gt;列出所有带注释的jsp - 文件 - ＆gt;提供jsp结构的摘要，包括上面的文档 - jspskelton：渲染html并将jsp嵌入为文本

请参阅：http://jspdoc.sourceforge.net/

为jsp页面doxygen？

1 个答案: