Maven javadoc

来源：互联网发布：c3p0连接池配置 mysql 编辑：程序博客网时间：2024/05/16 05:59

用Maven生成javadoc

首先在pom.xml增加如下内容：

<project>  ...  <reporting>    <plugins>      <plugin>        <groupId>org.apache.maven.plugins</groupId>        <artifactId>maven-javadoc-plugin</artifactId>        <version>2.10.1</version>        <reportSets>          <reportSet>            <id>html</id>            <configuration>              <doctitle>My API for ${project.name} ${project.version}</doctitle>              <windowtitle>My API for ${project.name} ${project.version}</windowtitle>              ...            </configuration>            <reports>              <report>javadoc</report>            </reports>          </reportSet>          <reportSet>            <id>test-html</id>            <configuration>              <testDoctitle>My Test API for ${project.name} ${project.version}</testDoctitle>              <testWindowtitle>My Test API for ${project.name} ${project.version}</testWindowtitle>              ...            </configuration>            <reports>              <report>test-javadoc</report>            </reports>          </reportSet>        </reportSets>      </plugin>    </plugins>  </reporting>  ...</project>

在命令行输入：mvn javadoc:test-javadoc or mvn javadoc:test-javadoc parameters

参见：

http://maven.apache.org/plugins/maven-javadoc-plugin/examples/test-javadocs.html

Codetemplates.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** * ${tags} */</template><template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** *  * ${tags} */</template><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/**  * ${see_to_overridden} */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/** * ${tags} * ${see_to_target} */</template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/** * Copyright (c) 2011-${year} All Rights Reserved. */</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**  */</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/** * * * @author ${user} * @version $$Id: ${type_name}.java ${date} ${time} $$ */</template><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">    /**     * Getter method for property <tt>${bare_field_name}</tt>.     *      * @return property value of ${field}     */</template><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">    /**     * Setter method for property <tt>${bare_field_name}</tt>.     *      * @param ${field} value to be assigned to property ${bare_field_name}     */</template></templates>

0 0