关于javadoc的那些。。。

本文主要讲解Javadoc是什么及其相应的运用。

含义

Javadoc是一项技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。

使用

使用命令行在目标文件所在目录输入javadoc +文件名.java。

常用符

@author

作者标识

@version

版本号

@param

方法的入参名及描述信息，如入参有特别要求，可在此注释。

@return

对函数返回值的注释。

@deprecated

标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。

@throws

构造函数或方法所会抛出的异常。

@exception

和@throws是相同的。

@see

查看相关内容，如类、方法、变量等。

@since

API在什么程序的什么版本后开发支持。

@link

链接到某个特定的成员对应的文档中。

@value

当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。