Javadoc介绍
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。
常用标记
@author 作者:作者
@version 版本号:版本号
@param 参数名描述:方法入参的描述信息
@return 描述:对函数返回值的注释
{@link包 类#成员 标签}ctrl+单击链接到某个特定成员对应的文档中
{@value}引用常量的值