java文档注释

java中注释有一下几种:

1

//单行注释

2

/*

多行注释

*/

3

/**

文档注释

*/

第三种是用来生成帮助文档的，sun公司提供了一个工具javadoc可以用来生成程序文档

/**
*这是一个用于表示引擎的类
*@author Demo1
*/
class Engine
{
	/**
	*启用引擎
	*@param 工作级别
	*/
	public void Start(int level)
	{
	
	}
	
	/**
	*停止引擎
	*/
	public void stop()
	{
	
	}
	
}

生成文档参数:javadoc -private -d d:\help -author -version Cars.java

在命令行下运行该工具

输入javadoc直接回车能看到所有的参数信息