Java文档注释，javadoc标签

作者：@kuaiquxie
作者的github：https://github.com/bitebita
本文为作者原创，如需转载，请注明出处：https://www.cnblogs.com/dzwj/p/15586529.html

---

Java文档注释

Java支持三种注释方式。前两种分别是Ⅱ和/产*，第三种被称作说明注释，它以产开始，以*I结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息，并输出到HTML文件中。说明注释，使你更加方便的记录你的程序信息。

 

javadoc标签

 

@author　　@标识一个类的作者　　

@deprecated　　@指名一个过期的类或成员　　

@docRoot　　@指明当前文档根目录的路径

@exception　　@标志一个类抛出的异常

@inheritDoc　　@从直接父类继承的注释
@link　　@插入一个到另一个主题的链接
@param　　@说明—个方法的参数
@return　　@说明返回值类型
@see　　@指定一个到另一个主题的链接
@serial　　@说明—个序列化属性

@serialData　　@说明通过writeObject()和writeExternal()方法写的数据

@serialField　　@说明一个ObjectStreamField组件
@throws和@exception标签—样.
@value　　@显示常量的值，该常量必须是static属性。
@version　　@指定类的版本