Doclava — это пользовательский Javadoc Doclet от Google, используемый Google Guice (см. Их более прохладные Javadocs ). Doclava использует JSilver в качестве движка шаблонов, реализацию Clearsilver на чистой Java. Мне лично нравится идея Федеративных Документов, чтобы позволить документам связываться и интегрироваться друг с другом в открытых проектах.
Вот основные отличия Доклава от стандартного Доклета:
- Обновленный внешний вид, включая возможности поиска.
- Встраивает информацию о версиях в документацию.
- Использует шаблонизатор для пользовательских настроек.
- Выдает ошибки сборки для вещей, которые могут быть легко перехвачены, например, теги @param, которые не соответствуют именам параметров.
- Возможность включать фрагменты кода из реального исходного кода
- Объединить документацию между несколькими сайтами.
- Возможность встраивать Javadocs в большую веб-страницу.
Использование Doclava с Javadoc
|
1
|
-doclet com.google.doclava.Doclava -docletpath ${jar.file} |
Используя Доклаву с Муравьем
|
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
<project> ... <target name="doclava" depends="jar"> <javadoc packagenames="com.google.*" destdir="build/docs" sourcepath="src" docletpath="${jar.file}" bootclasspath="${javahome}/jre/lib/rt.jar" > <doclet name="com.google.doclava.Doclava"> <param name="-stubs" value="build/stubs" /> <param name="-hdf"/> <param name="project.name"/> <param name="Doclava"/> <!-- versioning --> <param name="-since"/> <param name="doclava/previous.xml"/> <param name="v1" /> <param name="-apiversion" value="v2"/> <!-- federation --> <param name="-federate" /><param name="JDK"/> <param name="-federationxml"/><param name="JDK"/> </doclet> </javadoc> </target></project> |
Использование Doclava с Maven
|
01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
<project> ... <build> <plugins> ... <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <version>2.7</version> <configuration> <docletArtifact> <groupId>com.google.doclava</groupId> <artifactId>doclava</artifactId> <version>1.0.3</version> </docletArtifact> <doclet>com.google.doclava.Doclava</doclet> <!-- | bootclasspath required by Sun's JVM --> <bootclasspath>${sun.boot.class.path}</bootclasspath> <additionalparam> -quiet -federate JDK http://download.oracle.com/javase/6/docs/api/index.html? -federationxml JDK http://doclava.googlecode.com/svn/static/api/openjdk-6.xml -hdf project.name "${project.name}" -d ${project.build.directory}/apidocs </additionalparam> <useStandardDocletOptions>false</useStandardDocletOptions> <!-- | Apple's JVM sometimes requires more memory --> <additionalJOption>-J-Xmx1024m</additionalJOption> </configuration> </plugin> </plugins> </build></project> |
Улучшенные теги
Doclava поддерживает несколько дополнительных тегов, таких как @undeprecate (довольно понятный), @hide (удалить из документации), @include $ filePath (включает в себя текст из файла), @sample (включает в себя образец из файла) и несколько различных , Пожалуйста, посмотрите полный список здесь .
настройка
И если вы устали от старого внешнего вида Javadoc, вы можете настроить вывод Doclava . Для получения дополнительной информации нажмите здесь .
Ссылка: Doclava: Пользовательский Javadoc Doclet от Google от нашего партнера JCG Фелипе Оливейры .
Статьи по Теме: