注释大概可以分为三种
第一段:概要描述,简要描述该类的作用
第二段:详细描述,详细描述该类的作用
第三段:文档标注,用于标注作者、创建时间、参阅类等信息
javadoc还有很重要的便是Javadoc文档标记,这是Java中可以使用的,Java会识别这些标记
如@author、@version、@since、@see、@link、@code、@param、@return、@exception、@throws等
@link可以快速到达所链接的代码,后可以跟完全限定的类名(就是项目,包,类齐全的),也可以直接跟这个包内的类名,也可以跟完全限定的方法名,也可以直接跟这个class内的方法名.
@code 标记文本,在Java中一般涉及到类名或者方法名都要标记.
@see 来表示父类,或在本文本中使用的其他类,或者方法
@value 表示常量的值
@return 描述返回值,类型等等
@author表示作者
@version表示版本