如何从命令行生成Javadoc
有人能告诉我如何从命令行生成Javadoc吗 我的项目包含包如何从命令行生成Javadoc,java,command-line,javadoc,Java,Command Line,Javadoc,有人能告诉我如何从命令行生成Javadoc吗 我的项目包含包com.test,我想将生成的文档放在特定文件夹中的文件中,如下所示:C:/javadoc/test您可以参考 我想你看到的是这样的: javadoc -d C:\javadoc\test com.test Oracle提供了一些简单的示例: 假设您在~/中,java源代码树在./saxon\u source/net中,并且您希望在整个源代码树中递归,net既是一个目录又是顶级包名 mkdir saxon_docs javadoc
com.test
,我想将生成的文档放在特定文件夹中的文件中,如下所示:C:/javadoc/test
您可以参考
我想你看到的是这样的:
javadoc -d C:\javadoc\test com.test
Oracle提供了一些简单的示例: 假设您在~/中,java源代码树在./saxon\u source/net中,并且您希望在整个源代码树中递归,net既是一个目录又是顶级包名
mkdir saxon_docs
javadoc -d saxon_docs -sourcepath saxon_source -subpackages net
我相信这一定会对你有所帮助
javadoc -d C:/javadoc/test com.mypackage
例如,如果我的应用程序源代码结构如下所示:
javadoc -d C:\javadoc\test com.test
- 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包的源代码以及“C:\b2b”目录中的所有子包(递归)创建javadocs。假设您有以下目录结构,您希望在
file1.java
和file2.java
(package com.test)上生成javadocs,将javadocs放在C:\javadoc\test
:
C:\
|
+--javadoc\
| |
| +--test\
|
+--projects\
|
+--com\
|
+--test\
|
+--file1.java
+--file2.java
在命令终端中,导航到包的根目录:C:\projects
。如果您只想在项目中的所有java文件上生成标准javadocs,请运行以下命令(对于多个包,请用空格分隔包名):
如果要从其他地方运行javadocs,则需要指定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
可以找到更多信息/场景
若您想创建lang包的dock文件,那个么路径应该和您的lang包当前所在的位置相同。例如,我创建了一个文件夹名javaapi
,并解压缩了src
zip文件,然后使用下面的命令
C:\Users\Techsupport1\Desktop\javaapi\java\lang> javadoc *.java
只需转到保存所有java代码的文件夹,比如E:/javaFolder,然后
javadoc*.java
范例
E:\javaFolder>javadoc*.java
如果必须处理多个源路径和子包,则给出的答案并不完全完整
下面的命令行将处理位于/home/rudy/IdeaProjects/demo/src/main/java和/home/rudy/IdeaProjects/demo/src/test/java中的com和LOR(指环王)下的所有包/
请注意:
- 它是Linux,路径和包之间用“:”分隔
- 我使用了private,希望所有的类和成员都被记录下来
我建议看一下以下内容:只需做一些类似C:\>javadoc-DC:\javadoc\test C:\projects\com\test\*。否则使用java javadoc非常令人沮丧(至少在Windows中是这样)。该链接是死的,它会自动在包名后为我附加额外的“/”,比如,如果包是:
com.test
并且里面有Main类,那么它应该以com/test/Main.html
的形式输出,但它会尝试写入文件com/test//Main.html
,真奇怪!是的,这在Linux上也有效javadoc-d路径/to/output/folder myClass.java
C:\Users\Techsupport1\Desktop\javaapi\java\lang> javadoc *.java
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