java(四):注释用处以及帮助文档生成方式

单行注释(//)

java(四):注释用处以及帮助文档生成方式

多行注释(/内容/)

java(四):注释用处以及帮助文档生成方式

文档注释(/*内容/)

java(四):注释用处以及帮助文档生成方式

注释的用处

(1)版本信息声明
(2)生成帮助文档

帮助文档的生成

java应用的执行者并不能拿到源码,所以我们有必要对软件的用处和使用方法进行帮助说明,生成帮助文档的方式如下:

(1)首先使用/***/文档注释对代码进行说明,如下图

java(四):注释用处以及帮助文档生成方式
代码记得ctrl+s保存哦

(2)生成帮助文档
右键代码,打开属性
java(四):注释用处以及帮助文档生成方式

进入java代码文件目录,打开cmd,进入此文件目录

java(四):注释用处以及帮助文档生成方式

输入javadoc -d 生成的文件名+要生成帮助文档的java文件

java(四):注释用处以及帮助文档生成方式
java(四):注释用处以及帮助文档生成方式
java(四):注释用处以及帮助文档生成方式

java(四):注释用处以及帮助文档生成方式
java(四):注释用处以及帮助文档生成方式