01009_Eclipse文档导出帮助文档

1、在Eclipse使用时，可以配合文档注释，导出对类的说明文档，从而供其他人阅读学习与使用；

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

 1 /**
 2  * 类GetSum实现整数的求和
 3  * 
 4  * @author gzdlh
 5  * @version 1.0
 6  */
 7 public class GetSum {
 8     /**
 9      * 方法getSum功能计算两个整数的求和
10      * 调用此方法传递两个int整数，返回求和值
11      * 
12      * @param a
13      * @param b
14      * @return sum
15      */
16     public static int getSum(int a, int b) {
17         return a + b;
18     }
19 }

3、使用Eclipse导出javadoc文档即可，操作步骤如下：

　　选择File--Export--Java--Javadoc，输入文档保存的位置，打开index.html

　　

　　

　　

　　

 

 　　

　　

 

posted @ 2017-12-22 01:37  gzdlh  阅读(123)  评论(0)    收藏  举报