如何从命令行生成Javadoc
任何人都可以告诉我如何从命令行生成Javadoc?
我的项目包含com.test
包,我想把生成的文件放在一个特定的文件夹中,如下所示: C:/javadoc/test
。
你可以参考javadoc 8的文档
我认为你所看到的是类似的东西
javadoc -d C:/javadoc/test com.test
Oracle提供了一些简单的例子:
http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJBGFC
假设你在〜/中,并且java源码树在./saxon_source/net中,并且你想通过整个源码树进行recursion,那么net既是一个目录,也是最高的包名称。
mkdir saxon_docs javadoc -d saxon_docs -sourcepath saxon_source -subpackages net
假设您有以下目录结构,您要在file1.java
和file2.java
(package com.test)上生成javadoc,并将javadoc放置在C:\javadoc\test
:
C:\ | +--javadoc\ | | | +--test\ | +--projects\ | +--com\ | +--test\ | +--file1.java +--file2.java
在命令terminal中,导航到您的软件包的根目录: C:\projects
。 如果您只想在项目中的所有java文件上生成标准javadoc,请运行以下命令(对于多个包,请用空格分隔包名):
C:\projects> javadoc -d [path to javadoc destination directory] [package name] C:\projects> javadoc -d C:\javadoc\test com.test
如果你想从其他地方运行javadoc,你需要指定源path。 例如,如果您要在C:\
运行javadoc,则可以修改命令:
C:\> javadoc -d [path to javadoc destination directory] -sourcepath [path to package directory] [package name] C:\> javadoc -d C:\javadoc\test -sourcepath C:\projects com.test
如果只想在所选的.java文件上运行javadoc,则添加由空格分隔的源文件名(可以使用星号(*)作为通配符)。 确保包含文件的path:
C:\> javadoc -d [path to javadoc destination directory] [source filenames] C:\> javadoc -d C:\javadoc\test C:\projects\com\test\file1.java
更多信息/场景可以在这里find。
例如,如果我有一个像这样的应用程序源代码结构:
- C:\ B2B \ COM \史蒂夫\ UTIL \
- C:\ B2B \ COM \史蒂夫\应用程序\
- C:\ B2B \ COM \史蒂夫\ GUI \
然后我会做:
javadoc -d "C:\docs" -sourcepath "C:\b2b" -subpackages com
这应该为com包中的源代码创buildjavadocs,以及在“C:\ b2b”目录中find的所有子包(recursion)。
D:> javadoc * .java
如果你想创buildlang包的dock文件,那么path应该与你当前的lang包相同,例如我创build了一个文件夹名称javaapi和解压缩src zip文件。 然后使用命令作为bellow
C:\ Users \ Techsupport1 \ Desktop \ javaapi \ java \ lang> javadoc * .java
其简单的去所有的java代码保存的文件夹说E:/ javaFolder,然后javadoc *.java
例
E:\javaFolder> javadoc *.java
链接到JavaDoc
我相信这一定会帮助你。
javadoc -d C:/javadoc/test com.mypackage