帮助文档的制作（控制台、eclipse两种方式）

概述&＃xff1a;

​ 开发人员开发完代码分为源代码文件和字节码文件&＃xff0c;将来给客户的文件是字节码文件&＃xff0c;客户看不懂文件&＃xff0c;不会使用该文件。为了要客户更好的使用书写的代码文件需要开发者提供一个文件的使用帮助文档

如何生成帮助文档&＃xff1f;

​ 不需要自己逐字逐句的书写&＃xff0c;只需要使用jdk提供的一个程序javadoc.exe可以自动生成帮助文档。

步骤&＃xff1a;

​ 1、完成源文件的注释的书写

​ 文档注释&＃xff1a;【/** 注释内容 */】

​ 注释内容需要结合相关注解来书写

​ 帮助文档的常用注解&＃xff1a;

​ &＃64;author&＃xff1a;作者

​ &＃64;version&＃xff1a;版本号

​ &＃64;since&＃xff1a;从…开始 -------一般使用在类的注释中

​ &＃64;param&＃xff1a;参数

​ &＃64;return&＃xff1a;返回值 -------- 一般用于方法的注释中

​ 2、生成帮助文档&＃xff1a;javadoc.exe需要使用dos命令来调用

​ 在文件所在的目录下的命令行中输入都是命令。

​ 命令&＃xff1a;javadoc -d 文件夹名称 -author -version 源文件名.java

eclipse生成帮助文档的步骤&＃xff1a;

1、点击project中的generate javadoc…

2、在弹出的菜单中填写两个路径完成即可