用于构建的android项目的自动Javadoc

Question

我想为每个构建的库项目启用自动Javadoc生成.我有3个问题需要解决:

1. 如何在IDE的构建过程中集成这样的自动化脚本？(Eclipse和IDEA).

2. 如何从文档处理中排除自动生成的类R和Build类,因为它们始终在源的命名空间下生成.

3. 将Javadoc打包并放置在构建jar文件旁边的jar中.

这个问题有点宽泛,但我确信在一个地方找到一个好的综合答案可以为许多人省去麻烦.

Answer 1

两种方式:

• 使用Maven:Maven很棒,并且也有android构建支持.但仍然使用默认的android结构,一切都不像默认的Ant构建那样毫不费力.我希望将来谷歌推出Maven结构.
• 好旧Apache Ant:默认的ant构建文件所在sdk_path/tools/ant/build.xml,这是导入到项目中的build xml.因此,可以为一些额外的工作添加自定义目标.放置它们的最佳位置是custom_rules.xml项目根目录中的文件,并在项目中导入build.xml.

custom_rules.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project name="MyProject" default="help">

    <!-- IDE produces default jar as: out/production/classes.jar ,
    so we define a custom target to rename the jar, generate and package docs jar along
    with it  -->
    <target name="package_library" depends="init_pack_lib, check_lib_jar,   rename_lib_jar,generate_javadoc"/>

    <!-- init all properties to use-->
    <target name="init_pack_lib">
        <property name="real.out.dir" value="${basedir}/out/production"/>
        <property name="lib.gen.jar.file" value="${real.out.dir}/classes.jar"/>
        <property name="docs.dir" value="${real.out.dir}/Docs"/>

        <!-- we need to peek into manifest xml file-->
        <xmlproperty file="${manifest.abs.file}" collapseattributes="true"/>
        <property name="app.package" value="${manifest.package}"/>
        <property name="app.dist.name" value="${ant.project.name}_${manifest.android:versionName}"/>
        <property name="doc.package.names" value="${app.package}.*"/>
    </target>

    <!-- is classes.jar generated ?-->
    <target name="check_lib_jar">
        <available file="${lib.gen.jar.file}" property="lib.jar.found"/>
    </target>

    <!-- if so, give it a better name-->
    <target name="rename_lib_jar" if="${lib.jar.found}">
        <move file="${lib.gen.jar.file}"
              tofile="${real.out.dir}/${app.dist.name}.jar"/>
    </target>

    <!-- generate and package JavaDoc for project-->
    <target name="generate_javadoc" depends="check_doc_dir, create_doc_dir, clean_docs_dir">
        <javadoc packagenames="${doc.package.names}"
                 sourcepath="${source.absolute.dir}"
                 destdir="${docs.dir}"
                 verbose="false"
                />
        <jar compress="${jar.compress}" basedir="${docs.dir}" jarfile="${real.out.dir}/${app.dist.name}_JavaDoc.jar"/>
    </target>

    <!-- what about JavaDocs destination directory ? -->
    <target name="check_doc_dir">
        <condition property="docs.dir.not.exists">
            <not>
                <available type="dir" file="${docs.dir}" property="docs.dir.exists"/>
            </not>
        </condition>
    </target>

    <!-- make docs directory if it isn't there already-->
    <target name="create_doc_dir" if="docs.dir.not.exists">
        <mkdir dir="${docs.dir}"/>
    </target>

    <!-- wipe previous JavaDocs files-->
    <target name="clean_docs_dir" if="docs.dir.exists">
        <delete includeemptydirs="true">
            <fileset dir="${docs.dir}" includes="**/*"/>
        </delete>
    </target>
</project>

要创建包,只需ant package_library从项目根目录运行即可.您可以将它们包含在构建目标中,以便它们在每个构建上运行.