首页 > 代码库 > 使用javadoc生成API网页文档

使用javadoc生成API网页文档

2024-08-02 14:40:09   226人阅读

首先是一个简单的javadoc的用法的Demo：

1.创建普通java Project 

项目源码的根路径是  E:\androidworkspace\javadoc\src

项目结构：

项目源码：

net.qingtian.doc.Teacher：

package net.qingtian.doc;
/**
 * 老师
 * <img src=http://www.mamicode.com/"doc-files/Button.gif">>net.qingtian.doc.aa.Student：
package net.qingtian.doc.aa;

/**
 * 学生
 * @author 晴天 
 */
public class Student {
	/**
	 * 姓名
	 */
	public String name;
	
	/**
	 * 显示姓名
	 */
	public void showName(){
	}
}
 net.qingtian.doc.package.html：
<head>1234</head><body>abcd<a href=http://www.mamicode.com/"http://www.mabinbin.com">晴天

2.生成api文档
a)在e盘下创建mydoc文件夹，存放生成的api文档。
b)在windows下打开黑窗口，然后进入到项目源码的根目录，以上面的项目为例，源码根目录为E:\androidworkspace\javadoc\src
C:\Users\Administrator>e:
E:\>cd E:\androidworkspace\javadoc\drc
E:\androidworkspace\javadoc\src>
c)在e盘下创建文件 e:\ file.txt (文件的名字可随意，只要后面使用的时候和这个对应就可以)。文件的内容为  
net.qingtian.doc.aa
net.qingtian.doc
 d)在黑窗口执行命令：javadoc -d e:\mydoc e:\file.txt    
 即E:\androidworkspace\javadoc\src>javadoc -d e:\mydoc e:\file.txt
e)文档已经生成，查看


使用javadoc常遇到的问题：
首先   javadoc命令的格式          javadoc [ options ] [ packagenames ] [ sourcefiles ] [ @files ]  
1.options选项里   (-d  e:\mydoc    设置输出路径)   (-public/-protect/-private    设置哪些被生成文档)
2.使用javadoc时，可以使用以下参数   -sourcepath  E:\androidworkspace\javadoc\src   来设置需要生成api文档的源码的根路径，在我们刚才的操作中我们没有使用该选项，因为我们把黑窗口的当前路径设置为源码的根路径了，所以可以不使用该选项。
3. 使用javadoc时，可以设置-classpath classpathlist 这个参数，类似于-sourcepath sourcepathlist，只是他们一个是源码的路径，一个是二进制的文件的路径，不如有引用的外部的jar文件时设置，并不很常用。
4.javadoc可以为包和为文件生成api文档两种，对于为包生成文档时，不能递归的生成。如果包比较多，那么我们需要把包全部做为参数放在黑窗口命令的最后，这样当然是不方便的。所以有一个简单些的方式，也是刚才demo中用到的，就是把这些包名放在一个文件里，在命令的最后指定使用这个文件就可以 @filePath
5.中文乱码，javadoc默认是GBK编码，如果项目里用的是utf-8编码，那么在javadoc命令里添加选项-encoding UTF-8 -charset UTF-8
6.参考http://www.360doc.com/content/06/0901/14/5874_196090.shtml
使用javadoc生成API网页文档


联系
我们