javadoc
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。
1、生成方式:
1、命令行生成:javadoc xxx.java 。例如:javadoc -encoding UTF-8 -charset UTF-8 demo01.java;需要加字符集,否则中文易报错。
2、idea生成other command line arguments:-encoding utf-8 -charset utf-8
2、常用标记:
@autho:作者
@version :版本号
@parm :方法的入参名及描述信息,如入参有特别要求,可在此注释。
@since:jdk版本号
@see :引用,查看相关内容,如类、方法、变量等。
@return :描述,对函数返回值的注释
{@link包.类#成员 标签}:链接到某个特定的成员对应的文档中。
@throws:异常类名,构造函数或方法所会抛出的异常。
@exception: 异常类名,构造函数或方法所会抛出的异常。
{@value}:当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。
@deprecated : 过期文本,标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。
详细参见大佬文档:javadoc使用详解