如何从命令行生成 Javadoc

Question

谁能告诉我如何从命令行生成 Javadoc？

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

Answer 1

您可以参考 javadoc 8 文档

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

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

Answer 2

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

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

假设您位于 ~/ 并且 java 源代码树位于 ./saxon_source/net 中并且您想要递归通过整个源树网络既是一个目录又是顶级包名称。

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

Answer 3

假设您有以下目录结构，您希望在 file1.java 和 file2.java （包 com.test）上生成 javadoc，并将 javadocs 放置在 < code>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

如果您想从其他地方运行 javadocs，则需要指定源路径。例如，如果您要在 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

可以找到更多信息/方案 此处。

Answer 4

例如，如果我有一个如下所示的应用程序源代码结构：

• C:\b2b\com\steve\util\
• C:\b2b\com\steve\app\
• C:\b2b\com\steve\gui\

然后我会做：

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

这应该为 com 包的源代码和所有子包（递归地）创建 javadoc，在“C:\b2b”目录中找到。

Answer 5

很简单，转到保存所有 java 代码的文件夹，例如 E:/javaFolder，然后 javadoc *.java

示例

E:\javaFolder> javadoc *.java

Answer 6

如果必须处理多个sourcepath和子包，给出的答案并不完全完整。

以下命令行将处理位于 /home/rudy/IdeaProjects/demo/src/main/java 和 com 和 LOR（指环王）下的所有包/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

Answer 7

D:\>javadoc *.java

如果你想创建 lang 包的停靠文件，那么路径应该与你的 lang 包当前所在的路径相同。例如，我创建了一个名为 javaapi 的文件夹并解压缩 src zip 文件，然后使用以下命令。

C:\Users\Techsupport1\Desktop\javaapi\java\lang> javadoc *.java

Answer 8

JavaDoc 链接

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

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