javadoc
❶ 如何使用javadoc命令生成api文档，文档注释
代码如下：
[java]view plain
/**
*计算器工具类
*
*@authorGaoHuanjie
*@versionV1.0
*/
publicclassComputerUtil{
/*
*加法运算
*
*@parama加数a
*@paramb加数b
*@return返回两个整数的和
*/
publicstaticintadd(inta,intb){
returna+b;
}
/**
*减法运算
*
*@parama被减数
*@paramb减数
*@return返回两个整数的差
*/
publicstaticintsubtraction(inta,intb){
returna-b;
}
/**
*乘法运算
*
*@parama因数
*@paramb因数
*@return返回两个整数的乘积
*/
(inta,intb){
returna*b;
}
/**
*除法运算
*
*@parama被除数
*@paramb除数
*@return返回两个整数的商
*/
intdivision(inta,intb){
returna/b;
}
/**
*取余运算
*
*@parama被除数
*@paramb除数
*@return返回两个整数的相除后的余数
*/
privateintresial(inta,intb){
returna%b;
}
}
步骤：
①、打开DOS窗口；
②、定位到到该类的源文件所在文件夹；
③、输入命令：javadoc -d c:help -author -version ComputerUtil.java
说明：-d：其后空一格，用来指定生成的帮助文档存放的位置；
-author：用来指定生成的帮助文档必须显示该类的作者，如果没有这一命令则生成的帮助文档将不会显示作者；
-version：用来指定生成的帮助文档必须显示该类的版本，如果没有这一命令则生成的帮助文档将不会显示版本；
④、点击回车键。
结论：
①、Java中多行注释分为文档注释和非文档注释，只有文档注释所注释的内容才会出现在帮助文档中，非文档注释所注释的内容不会出现在帮助文档中（比如add方法，由于该方法的注释是非文档注释，所以注释内容没有生成到帮助文档中，只出现了该方法的一些信息）；
②、只有被public和protected修饰的方法添加的文档注释的注释内容才能出现在帮助文档中，所以division方法和resial方法尽管采用了文档注释，但注释内容和方法信息却没有出现在帮助文档中；