java基础(三)制作文档说明书

最新推荐文章于 2022-03-23 19:05:02 发布

原创最新推荐文章于 2022-03-23 19:05:02 发布 · 321 阅读

0 ·

CC 4.0 BY-SA版权

java基础专栏收录该内容

11 篇文章

订阅专栏

博客介绍了Java文档说明书的制作与使用方法。制作时，先对工具类加入文档注释，再通过javadoc命令生成，可提取作者、版本等内容。使用时，需找到并打开文档，通过索引查找类，查看类的结构，包括是否导包、成员变量、构造方法和成员方法等。

                    
                    制作文档说明书

A:对工具类加入文档注释 

B:通过javadoc命令生成说明书
@author(提取作者内容)
@version(提取版本内容)
javadoc -d 指定的文件目录 -author -version ArrayTool.java
@param 参数名称//形式参数的变量名称@return 函数运行完返回的数据

使用文档说明书

A:找到文档，打开文档
B:点击显示，找到索引，出现输入框
C:你应该知道你找谁?举例：Scanner
D:看这个类的结构(需不需要导包) 

成员变量    字段
构造方法    构造方法
成员方法    方法