如何从命令行生成Javadoc

时间:2011-01-04 10:01:35

标签: java command-line javadoc

有人能告诉我如何从命令行生成Javadoc吗?

我的项目包含包com.test,我想将生成的文档放在特定文件夹中的文件中,如下所示:C:/javadoc/test

8 个答案:

答案 0 :(得分:43)

您可以参考javadoc 8 documentation

我认为你所看到的是这样的:

javadoc -d C:\javadoc\test com.test

答案 1 :(得分:25)

Oracle提供了一些简单的示例:

http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJBGFC

假设您在〜/并且java源代码树位于./saxon_source/net中,并且您希望通过整个源代码树递归,则net既是目录又是顶级包名称。

mkdir saxon_docs
javadoc -d saxon_docs -sourcepath saxon_source -subpackages net

答案 2 :(得分:11)

假设您有以下目录结构,您希望在file1.javafile2.java(包com.test)上生成javadoc,并将javadoc放在C:\javadoc\test中:

C:\
|
+--javadoc\
|  |
|  +--test\
|
+--projects\
   |
   +--com\
      |
      +--test\
         |
         +--file1.java
         +--file2.java

在命令终端中,导航到程序包的根目录: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,则需要指定sourcepath。例如,如果您要在C:\中运行javadocs,则可以修改命令:

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文件上运行javadocs,则添加以空格分隔的源文件名(可以使用星号(*)表示通配符)。确保包含文件的路径:

C:\> javadoc -d [path to javadoc destination directory] [source filenames]

C:\> javadoc -d C:\javadoc\test C:\projects\com\test\file1.java

可以找到更多信息/方案here

答案 3 :(得分:5)

例如,如果我的应用程序源代码结构如下所示:

  • C:\ B2B \ COM \史蒂夫\ UTIL \
  • C:\ B2B \ COM \史蒂夫\应用\
  • C:\ B2B \ COM \史蒂夫\ GUI \

然后我会这样做:

javadoc -d "C:\docs" -sourcepath "C:\b2b" -subpackages com

这应该为com包中的源代码创建javadoc,并在“C:\ b2b”目录中找到所有子包(递归)。

答案 4 :(得分:2)

简单到你保存所有java代码的文件夹说E:/ javaFolder然后javadoc *.java

例如

E:\javaFolder> javadoc *.java

答案 5 :(得分:2)

如果必须处理多个 源路径和子包,给出的答案并不完全。

以下命令行将处理位于/ home / rudy / IdeaProjects / demo / src / main / java 和<下的com LOR(指环王)下的所有软件包。 / strong> / home / rudy / IdeaProjects / demo / src / test / java /

请注意:

  • 这是Linux,路径和包用':'分隔。
  • 我使用private并希望记录所有的类和成员。

rudy@rudy-ThinkPad-T590:~$ javadoc -d /home/rudy/IdeaProjects/demo_doc
-sourcepath /home/rudy/IdeaProjects/demo/src/main/java/
:/home/rudy/IdeaProjects/demo/src/test/java/
-subpackages com:LOR 
-private

rudy@rudy-ThinkPad-T590:~/IdeaProjects/demo/src/main/java$ ls -R 
.: com LOR
./com: example
./com/example: demo
./com/example/demo: DemowApplication.java
./LOR: Race.java TolkienCharacter.java

rudy@rudy-ThinkPad-T590:~/IdeaProjects/demo/src/test/java$ ls -R 
.: com
./com: example
./com/example: demo
./com/example/demo: AssertJTest.java DemowApplicationTests.java

答案 6 :(得分:1)

Link to JavaDoc

我相信这一定会对你有所帮助。

javadoc -d C:/javadoc/test com.mypackage

答案 7 :(得分:1)

D:&gt; javadoc * .java

如果你想创建lang包的dock文件,那么path应该与你当前的lang包相同 例如 我创建了一个文件夹名称javaapi并解压缩src zip文件。 然后使用命令如下:

C:\用户\ Techsupport1 \桌面\ JAVAAPI \的java目录\ lang&GT; javadoc * .java