java基础之java文档注释_繁星漫天_新浪博客

java中提供了javadoc命令，它可以将这些帮助信息提取出来，自动生成HTML格式的帮助文档，从而实现程序的文档化。

例子：

public class Person

{

public String name;

public Person(String name){

//执行语句

}

public int read( String bookName,int time){

//执行语句

}

}

@author  用于对类的说明，表示这个程序的作者

@version 用于对类的说明，表示这个程序的开发版本号

@param  用于对方法的说明，表示方法定义的参数以及参数对应的说明

@return  用于对方法的说明，表示方法的返回值代表的意义

打开命令窗口，进入程序所在的目录，输入生成文档的命令

javadoc -d . -version -author Person.java

其中：

-d:  用来指定输出的文档存放的目录

.   表示当前目录

-version:  用来指定输出文档中需包含版本信息

-author: 用来指定输出文档中需包含作者的信息

目录下的index.html文件是整个帮助文档的首页