使用javadoc生成文档

最新推荐文章于 2024-08-17 19:27:54 发布

原创最新推荐文章于 2024-08-17 19:27:54 发布 · 679 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#javadoc

其他专栏收录该内容

15 篇文章

订阅专栏

本文介绍了Java接口的定义及其实现，通过示例ITestDoc和TestDoc展示了接口与其方法的具体实现。此外，详细说明了如何使用命令行和Eclipse生成API文档，包括设置参数如目录、标题、作者等，以及导出文档的具体步骤。

部署运行你感兴趣的模型镜像

先搞段代码

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();
	}
}