Doclava是Google的自定義Javadoc Doclet，由Google Guice使用（請參閱稍冷的 Javadocs ）。 Doclava使用JSilver作為其模板引擎，這是Clearsilver的純Java實現(xiàn)。 我個人喜歡聯(lián)合文檔的想法，它允許文檔在打開的項目上相互鏈接和集成。

這是Doclava與標(biāo)準(zhǔn)Doclet之間的主要區(qū)別：

• 刷新后的外觀，包括搜索功能。
• 將版本信息嵌入文檔中。
• 使用模板引擎進(jìn)行用戶自定義。
• 為容易捕獲的內(nèi)容引發(fā)構(gòu)建錯誤，例如與參數(shù)名稱不匹配的@param標(biāo)記。
• 能夠包含來自真實源代碼的代碼片段
• 多個站點之間的聯(lián)合文檔。
• 能夠?qū)avadocs嵌入更大的網(wǎng)頁中。

將Doclava與Javadoc結(jié)合使用

-doclet com.google.doclava.Doclava -docletpath ${jar.file}

將Doclava與Ant結(jié)合使用

<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="http://download.oracle.com/javase/6/docs/api/index.html?"/><param name="-federationxml"/><param name="JDK"/><param name="http://doclava.googlecode.com/svn/static/api/openjdk-6.xml"/></doclet></javadoc></target> </project>

在Maven中使用Doclava

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

改進(jìn)的標(biāo)簽

Doclava支持一些額外的標(biāo)簽，例如@undeprecate（非常不言自明），@ hide（從文檔中刪除），@ include $ filePath（包括文件中的文本），@ sample（包括文件中的示例）和一些其他標(biāo)簽。 。 請在此處查看完整列表。

客制化

而且，如果您對舊的Javadoc外觀感到厭倦，可以自定義Doclava的輸出。 有關(guān)更多信息，請單擊此處 。

參考： Doclava：來自我們的JCG合作伙伴Felipe Oliveira的 Google自定義Javadoc Doclet 。

相關(guān)文章：

• 帶有Spring和Maven教程的JAX–WS
• GWT EJB3 Maven JBoss 5.1集成教程
• Tomcat 7上具有RESTeasy JAX-RS的RESTful Web服務(wù)-Eclipse和Maven項目
• 正確記錄應(yīng)用程序的10個技巧
• 每個程序員都應(yīng)該知道的事情

翻譯自: https://www.javacodegeeks.com/2011/03/doclava-custom-javadoc-doclet-from.html

總結(jié)

以上是生活随笔為你收集整理的Doclava：来自Google的自定义Javadoc Doclet的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。