Javadoc的基本语法

Javadoc的基本语法

一、Javadoc可以写于类和方法上面。Javadoc 选项 java源文件/清单文件，且标记的使用是有位置限制的。
二、写在类上面的Javadoc分为三段，分别为概要描述、详细描述和文档标注
1、@link 用于快速链接到相关代码
2、@code 将文本标记为code，将文本标记为代码样式的文本，涉及到类名和方法名的都需用此来标记。
3、@param 一般类中解释泛型的类型
4、@author 指定程序作者。用于类或接口的注释
5、@see “参见”
6、@since 用于标记文件创建时项目当时对应的版本 ，表示文件创建的时间
7、@version 指定类的版本
二、写在方法上面的Javadoc分为三段，也分别为概要描述、详细描述和文档标注，常见的标记如下：
1、@param 跟参数名，跟参数描述
2、@return 方法的返回值
3、@throws 抛出的异常，与exception同义
4、@see 表示可以参考的类或者方法
5、@value 表示常量的值