016_JAVA基础语法_文档标记

文档标记常用于包/类/方法javadoc注释的第三段。

常见标签

1. @author

   • 用于指明作者，可附加邮箱或超链接

   • 有多少个作者就要用多少个该标签

   • 有时留的是组织名或邮箱

   • 不知道作者是谁时，就写 @author unascribed

   • 

2. @version 用于指明当前版本号

3. @since

   • 用于指明最早出现在哪个版本

   • 也可填版本号或日期

   • 也可填可运行的JDK版本

4. @param

   • 说明方法的参数

   • 先接参数名，再接参数描述，有几个参数就用几个该标签

     

5. @code

   • 将一些关键字或代码解析成代码样式（类似英文论文中对变量使用斜体）

   • 以下必须使用该标签：Java keywords、package names、class names、method names、interface names、filed names、argument names、code examps。

     

6. @return

   • 用于说明return的内容

   • 方法有返回值时必须包括该标签

     

7. @throws、@exception

   • 描述何时抛出异常

   • @throws、@exception是一模一样的

     

所有图片来源：https://www.cnblogs.com/linj7/p/14339381.html