先搞段代码
ITestDoc.java
/**
* 2020年3月20日上午10:42:30
*/
package com.xwf.testdoc;
/**
* 测试doc接口
* @author XWF
*
*/
public interface ITestDoc {
/**
* 测试接口方法
* @param str 字符串参数
* @return 返回一个字符串
*/
public String fun(String str);
}
TestDoc.java
/**
* 2020年3月20日上午10:47:13
*/
package com.xwf.testdoc;
/**
* 测试接口实现类
* @author XWF
*
*/
public class TestDoc implements ITestDoc {
/**
* 实现方法
*/
@Override
public String fun(String str) {
return null;
}
}
TestDoc2.java
/**
* 2020年3月20日上午10:44:25
*/
package xwf.com.testdoc;
/**
* 另一个包的类
* @author XWF
*
*/
public class TestDoc2 {
/**
* 将小写字母转为大写字母
* @param str 小写字母
* @return 返回的转换后的大写字母
* @exception NullPointerException 参数为空
*/
public String toUpper(String str) throws NullPointerException {
return str.toUpperCase();
}
}
一、命令行生成
在项目目录下shift右键打开命令行
执行命令:javadoc -d 生成目录 -header 测试生成DOC -doctitle 这是Title -version -author -
encoding utf-8 -sourcepath .\src\ -subpackages com -subpackages xwf
生成文档
大概就是这个样子
二、eclipse生成
项目上右键,Export,选择java下面的@javadoc
选择javadoc命令,要导出的项目和包,可见导出类型
勾选填写title,勾选导出操作
设定编码:-encoding UTF-8 -charset UTF-8
Finish导出