1.内容
| 解释 | |
|---|---|
| // 内容 | 单行注释 |
| /* 内容 */ | 多行注释 |
| /*** 内容 */ | 文档注释 |
2.多行注释 与 文档注释的区别
多行注释：
文档注释：JDK提供工具javadoc解析 注释的内容，为生成API文档做准备
3.生成步骤
4.javadoc标签
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 作者 | @author liudelantu |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| {@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数 | @param parameter-name explanation |
| @return | 说明返回值类型 | @return explanation |
| @see | 指定一个到另一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | @since release |
| @throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
| @version | 版本 | @version 1.0 |
5.规范
类，方法的注释，要用javadoc的方式写，为了在生成的API文档上 说明此类或方法的用途