使用javadoc命令制作帮助文档(API)
2013-11-06 07:51
597 查看
代码如下:
/**
* 计算器工具类
*
* @author GaoHuanjie
* @version V1.0
*/
public class ComputerUtil {
/*
* 加法运算
*
* @param a 加数a
* @param b 加数b
* @return 返回两个整数的和
*/
public static int add(int a, int b){
return a+b;
}
/**
* 减法运算
*
* @param a 被减数
* @param b 减数
* @return 返回两个整数的差
*/
public static int subtraction(int a, int b){
return a-b;
}
/**
* 乘法运算
*
* @param a 因数
* @param b 因数
* @return 返回两个整数的乘积
*/
protected static int multiplication(int a, int b){
return a*b;
}
/**
* 除法运算
*
* @param a 被除数
* @param b 除数
* @return 返回两个整数的商
*/
int division(int a, int b){
return a/b;
}
/**
* 取余运算
*
* @param a 被除数
* @param b 除数
* @return 返回两个整数的相除后的余数
*/
private int residual(int a, int b){
return a%b;
}
}
步骤:
①、打开DOS窗口;
②、定位到到该类的源文件所在文件夹;
③、输入命令:javadoc -d c:\help -author -version ComputerUtil.java
说明:-d:其后空一格,用来指定生成的帮助文档存放的位置;
-author:用来指定生成的帮助文档必须显示该类的作者,如果没有这一命令则生成的帮助文档将不会显示作者;
-version:用来指定生成的帮助文档必须显示该类的版本,如果没有这一命令则生成的帮助文档将不会显示版本;
④、点击回车键。
结论:
①、Java中多行注释分为文档注释和非文档注释,只有文档注释所注释的内容才会出现在帮助文档中,非文档注释所注释的内容不会出现在帮助文档中(比如add方法,由于该方法的注释是非文档注释,所以注释内容没有生成到帮助文档中,只出现了该方法的一些信息);
②、只有被public和protected修饰的方法添加的文档注释的注释内容才能出现在帮助文档中,所以division方法和residual方法尽管采用了文档注释,但注释内容和方法信息却没有出现在帮助文档中;
/**
* 计算器工具类
*
* @author GaoHuanjie
* @version V1.0
*/
public class ComputerUtil {
/*
* 加法运算
*
* @param a 加数a
* @param b 加数b
* @return 返回两个整数的和
*/
public static int add(int a, int b){
return a+b;
}
/**
* 减法运算
*
* @param a 被减数
* @param b 减数
* @return 返回两个整数的差
*/
public static int subtraction(int a, int b){
return a-b;
}
/**
* 乘法运算
*
* @param a 因数
* @param b 因数
* @return 返回两个整数的乘积
*/
protected static int multiplication(int a, int b){
return a*b;
}
/**
* 除法运算
*
* @param a 被除数
* @param b 除数
* @return 返回两个整数的商
*/
int division(int a, int b){
return a/b;
}
/**
* 取余运算
*
* @param a 被除数
* @param b 除数
* @return 返回两个整数的相除后的余数
*/
private int residual(int a, int b){
return a%b;
}
}
步骤:
①、打开DOS窗口;
②、定位到到该类的源文件所在文件夹;
③、输入命令:javadoc -d c:\help -author -version ComputerUtil.java
说明:-d:其后空一格,用来指定生成的帮助文档存放的位置;
-author:用来指定生成的帮助文档必须显示该类的作者,如果没有这一命令则生成的帮助文档将不会显示作者;
-version:用来指定生成的帮助文档必须显示该类的版本,如果没有这一命令则生成的帮助文档将不会显示版本;
④、点击回车键。
结论:
①、Java中多行注释分为文档注释和非文档注释,只有文档注释所注释的内容才会出现在帮助文档中,非文档注释所注释的内容不会出现在帮助文档中(比如add方法,由于该方法的注释是非文档注释,所以注释内容没有生成到帮助文档中,只出现了该方法的一些信息);
②、只有被public和protected修饰的方法添加的文档注释的注释内容才能出现在帮助文档中,所以division方法和residual方法尽管采用了文档注释,但注释内容和方法信息却没有出现在帮助文档中;
相关文章推荐
- 使用javadoc命令制作帮助文档(API)
- 文档注释使用javadoc工具生成自己的api帮助文档
- 用javadoc命令生成api帮助文档
- java学习笔记-使用javadoc命令生成API文档
- 如何用javadoc命令,生成api帮助文档
- Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档
- 帮助文档API的使用和制作
- 制作帮助文档、利用api文档学习工具类使用、代码块、继承及继承的注意点
- 用javadoc命令生成api帮助文档
- 生成javadoc帮助文档 ( 使用eclipse. 命令)
- 用javadoc命令生成api帮助文档
- 用javadoc命令生成api帮助文档
- 用javadoc命令生成api帮助文档
- 用javadoc命令,生成api帮助文档
- 一款比较不错的由word制作帮助文档的好软件!wordToChm 专业版!推荐使用!
- Java中使用javadoc命令生成文档
- 8 面向对象(制作帮助文档,通过JDK提供的API学习了Math类,代码块,继承(继承子父成员访问特点,super关键字,方法重写))
- 使用javaHelp制作java swing帮助文档
- Java(四)——Java的文档注释(使用javadoc工具生成API文档)
- Eclipse用法:使用Javadoc导出项目的API文档