笔记(1):文档注释的相关使用

文档注释的相关使用

package com.tedu.doc;
/**
 * 
 * 这个类是用来演示文档注释所用
 * 文档注释一般作用于：类、方法、属性等
 * 一般用来编写当前类、方法、属性等的功能或者是设计目的的描述
 * 常用的如：
 * author:作者；
 * since:从什么时候JDK版本开始，或者说是可以最低运行在什么版本；
 * version:版本号
 * see:可以说这个类与什么其他类有关系
 * 
 * @author Wildmess
 * @since JDK1.5
 * @version 1.0
 * @see java.lang.String
 *
 */
public class APIDocDemo {
	/**
	 * sayHello中的问候语
	 * 常量文档注释的练习使用
	 */
	public static final String MSG = "你好";
	
	/**
	 * 文档注释注释方法
	 * 返回对给定用户的问候语
	 * @param name	用户名
	 * @return			问候的字符串
	 */
	public String sayHello(String name) {
		return name + "，" + MSG;	//返回调用的参数+你好
	}
}

导出Javadoc文档

1.点击File–>Export

2.在之后的窗口中找到Java–>Javadoc，之后next

3.选择好对应的按钮，勾上对应的选项，确定相关的地址。

4.之后，默认next，或者直接选择finish
5.在自己选择生成的API文档地址找到doc文件夹，点击index.html，即可查看自己的API文档。