文档注释导出帮助文档

一、概念

文档注释：使用文档注释，将类或者方法进行注释用@简单标注基本信息。如@author 作者、@version代码版本、@param方法参数、@return方法返回值等。

二、如何做

1.在类中写作者、版本以及参数、返回值和类的功能作用

代码如下：

package cn.itcast.Test03;
/**
 * 
 * @author JIAO
 * @version 1.0
 */
public class Person {
	/**
	 * 返回两个人的年龄和
	 * @param a
	 * @param b
	 * @return a+b
	 */
	public static int sumAge(int a,int b){
		return (a+b);
	}
	
}

2.点击File——打开Export——选择Java——选择JARdoc

  

3.此时出现错误Javadoc不存在的错误，这是因为Javadoc commmand没有选择。

  

4.在Configuration中找到jdk——bin——javadoc.exe，再次选择保存位置即可。

  

5.在保存的目录里出现doc文件夹，此时用浏览器打开里面的index.html

  

6.此时可以看到之前的文档注释已经是网页型的帮助文档

  

小结

学习的越多发现自己不知道的东西越来越多，这次帮助文档的生成，虽然比较简单，但是也是第一次接触这个东西。期间也出现一些问题，重要还是自己多尝试，多做，多百度。出来以后发现很多人都特别厉害，自己就特别差劲，不过重要的一直学习，不断进步，超越自己就好。