本文介绍在windows环境下，用cmd命令对java工程中的文件生成api文档；
一、针对“工程”级别的项目源文件
1.新建文本文件：package.txt，列出所有的包名；如下
org.eclipse.swt org.eclipse.swt.accessibility org.eclipse.swt.awt org.eclipse.swt.browser org.eclipse.swt.custom org.eclipse.swt.dnd org.eclipse.swt.events org.eclipse.swt.graphics org.eclipse.swt.internal org.eclipse.swt.internal.gdip org.eclipse.swt.internal.image org.eclipse.swt.internal.mozilla org.eclipse.swt.internal.mozilla.init org.eclipse.swt.internal.ole.win32 org.eclipse.swt.internal.opengl.win32 org.eclipse.swt.internal.theme org.eclipse.swt.internal.win32 org.eclipse.swt.layout org.eclipse.swt.ole.win32 org.eclipse.swt.opengl org.eclipse.swt.printing org.eclipse.swt.program org.eclipse.swt.widgets
2.小技巧：shift+鼠标右键，“在此处打开命令窗口”，进入cmd窗口，输入如下命令：
javadoc -d api @package.txt
注：api表示帮助文档的存放目录名，@package.txt表示以文件的形式传入包名；
3.执行完之后，会生成api文件夹，内部有如下的目录：
二、常用命令举例（生成单独文件或单独目录api）
1 javadoc -d api org/eclipse/swt/SWT.java //处理单个源文件 2 javadoc -d api org.eclipse.swt //处理单个包 3 javadoc -d api org.eclipse.swt org.eclipse.swt.widgets //处理多个包，如果处理的包较少，可以采用直接输入的方法 4 javadoc -private -d api @package.txt //处理多个包。生成最完整的帮助文档，包括带有private修饰符的属性和方法
注：本文制作api的方法，适用于所有java开源项目，只要有源码就可以。
参考文档：
http://blog.sina.com.cn/s/blog_6d5c82a70100omah.html
原文地址：https://www.cnblogs.com/silence-fire/p/9020072.html
时间： 2024-11-05 13:44:32