如何将Javadoc嵌入到Netbeans的Jar中

Question

是否可以自动将javadoc嵌入到NetBeans的jar中？在程序中有一个生成javadoc的选项。这将创建一个从项目中现有javadoc生成的完成网站。还有一个选项可以将javadoc附加到项目或jar中，以便它显示在建议中。现在，当我单击构建然后将jar并将其添加到另一台计算机上的项目时，jar的javadoc不会显示。我必须手动将其复制到计算机并附加它，这在我应该自动连接时似乎是多余的。

我尝试的事情：

• 使用'清洁和构建'，只是'构建'
• 导出整个dist文件夹，而不仅仅是jar。
• 将javadoc放入jar中。

Answer 1

假设您使用的是基于Ant的默认Netbeans项目，则需要修改项目build.xml文件以包含JavaDocs的生成，并将生成的文件复制到build.classes.dir中，以便它们可以Jar'ed

首先点击Files标签旁边的Projects标签，展开项目节点，您会看到根目录中的build.xml文件

接下来，您需要在编译和jar处理之间的构建过程中注入一些功能。通过阅读build.xml内的信息，-post-compile目标可能是我们想要开始的地方。

阅读the javadoc ant task documentation后，我将其添加到build.xml

    <target name="-post-compile">
        <javadoc 
            sourcepath="src"
            defaultexcludes="yes"
            destdir="javadocs"
            author="true"
            version="true"
            use="true"
            windowtitle="The name of your API"
        >
            <doctitle><![CDATA[<h1>My API</h1>]]></doctitle>
            <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
            <tag name="todo" scope="all" description="To do:"/>
            <link offline="true" href="http://docs.oracle.com/javase/8/docs/api/" packagelistLoc="C:\tmp"/>
            <link href="http://docs.oracle.com/javase/8/docs/api/"/>                
        </javadoc>
        <copydir src="javadocs" dest="${build.classes.dir}/javadocs"/>
    </target>

因此，我将此文件直接放在<import file="nbproject/build-impl.xml"/>文件的build.xml下，但它的位置应该很重要。

这会生成一个包含javadocs目录（和javadocs）的jar文件