Eclipse文档注释

版权声明:未经同意,严禁转载 https://blog.csdn.net/pengchengliu/article/details/88077973

                                                                                                                                              点击此处返回总目录

我们自己写了一个类,想让别人使用。就需要告诉他怎么使用。

文档注释这么写 

/**

 *   @author apple

 *   类GetSum实现整数求和

 *   @version  1.0

 */

public class GetSum{

/**

 *  方法getSum计算两个整数的求和

 *  调用此方法传递两个整数,返回求和

 *  @prarm a

 *  @prarm b

 *  @return 

 */

         public static void  int getSum(int a, int b){

                 return a+b;

         }

}

把写的文档注释导出帮助文档:

在要导出的包上,右键->Export->java -> javadoc,然后选择路径,导出即可。注意生成的是一个网页,打开index.html即可。

猜你喜欢

转载自blog.csdn.net/pengchengliu/article/details/88077973