如何使用javadoc命令生成api文档，文档注释

微信公开课小程序热门讨论「如何使用javadoc命令生成api文档，文档注释」最新回复-使用javadoc命令生成api文档：创建java源文件包。java文件都是存放在一个package包中，这样方便对java文件进行操作和区分，首先在磁盘上创建文件夹一样的方式创建package包。创建java源文件。在包下，创建与文件名相同的java源文件，输入一些文档注释，这些文档注释用于自动的api文件进行说明使用。进入java源文件目录。通过cd等windows命令进入java源文件包所在的磁盘位置。查看javadoc命令使用说明。如果是第一次使用javadoc命令，可以通过javadochelp命令查看javadoc使用说明。开始创建api文件。使用命令输入javadocdjavaapiheader测试的APIdoctitle这是我的第一个文档注释versionauthorjavadoc/Hello.java进行文档生成。d:文件存储位置;head:文件头部名称;version:显示版本;author:显示作者;javadoc/Hello.java处理的文件包以及java源文件。查看生成的api文件。创建成功之后，就会自动创建指定的文件夹下生成api文件。打开index.html就是api文件的入口。
代码如下：[java]viewplaincopy/***计算器工具类**@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返回两个整数的乘积*/protectedstaticintmultiplication(inta,intb){returna*b;}/***除法运算**@parama被除数*@paramb除数*@return返回两个整数的商*/intdivision(inta,intb){returna/b;}/***取余运算**@parama被除数*@paramb除数*@return返回两个整数的相除后的余数*/privateintresidual(inta,intb){returna%b;}}步骤：①、打开DOS窗口；②、定位到到该类的源文件所在文件夹；③、输入命令：javadoc-dc:help-author-versionComputerUtil.java说明：-d：其后空一格，用来指定生成的帮助文档存放的位置；-author：用来指定生成的帮助文档必须显示该类的作者，如果没有这一命令则生成的帮助文档将不会显示作者；-version：用来指定生成的帮助文档必须显示该类的版本，如果没有这一命令则生成的帮助文档将不会显示版本；④、点击回车键。结论：①、Java中多行注释分为文档注释和非文档注释，只有文档注释所注释的内容才会出现在帮助文档中，非文档注释所注释的内容不会出现在帮助文档中（比如add方法，由于该方法的注释是非文档注释，所以注释内容没有生成到帮助文档中，只出现了该方法的一些信息）；②、只有被public和protected修饰的方法添加的文档注释的注释内容才能出现在帮助文档中，所以division方法和residual方法尽管采用了文档注释，但注释内容和方法信息却没有出现在帮助文档中； 更多有关「如何使用javadoc命令生成api文档，文档注释」的疑问请扫码关注微信公开课+小程序！