欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

java注释及自动生成文档

程序员文章站 2024-01-17 12:55:52
...

单行注释

多行注释(这里不再解释)


java注释及自动生成文档


这个就相当于空调说明书

文档注释上面有两个星号,生成的文档默认以Html形式保存,可以生成说明文档


JavaDoc命令

从程序源代码中抽取文档注释形成一个和源代码配套的API帮助文档,在编写程序时以文档标签做注释,在编写完成后,通过Javadoc可以自动生成程序的开发文档

简单实用命令:javadoc -d 生成目标路径 源文件

/**
 *	Description:这是我的第一个Java程序
 *  Author:胡振华
 *  Create Date:2017-12-17
 *	Modified Date:2017-12-17
 *	Modified By:zhangsan
 *
 */

public class MyFirstJava{
	
	/**
	 *	Description:这是程序的入口点
	 *	参数:字符串数组
	 */
	public static void main(String[] args){
		
		
		
	}
	
	/**
	 *	Description:显示输出的个人信息
	 *	@return String 姓名
	 *	@param content 个人资料
	 */
	public String toString(String content){
		
		return content;
	}
	
}



java注释及自动生成文档


为什么会出现乱码,等到以后再来深入研究吧