Doxygen для страниц JSP? - PullRequest
Новая
       23

Doxygen для страниц JSP?

2 голосов
/ 01 сентября 2010

Мне нужно документировать (довольно) большой проект в java + jsp (1.0 ... не заставляйте меня начинать).

Для среднего уровня (все классы .java) я просто использовал doxygen для генерации документов .html и .pdf, но мой начальник попросил меня документировать и интегрировать документацию страниц .jsp.

AFAIK, не Doxygen и Javadoc, не подходят для этой работы. Я не прав?

Единственный способ, которым я могу думать, это вставить <%/** javadoc-style comments */%> в страницы jsp, затем скомпилировать .jsp в файлы .java, затем применить doxygen ... но это немного слишком сложно ...

1 Ответ

1 голос
/ 15 июня 2011

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>
*/

, и вы можете просматривать эту коллекцию с помощью трех служб: - каталог -> список всех JSP с комментариями - document -> предоставить краткое описание структуры jsp, включая вышеуказанную документацию - jspskelton: визуализировать HTML и встроить JSP в текст

см .: http://jspdoc.sourceforge.net/

...