长春网站百度网盘客户端
注释
为什么要写注释？
-
养成良好的编程习惯，方便后续阅读和查看，理顺思路，增加可读性
-
对自己的代码负责，对别人负责
说明
-
1. 被注释的文字，不会被 JVM（虚拟机）解释执行
-
2. 多行注释里面不允许有多行注释嵌套
1. 单行注释
//文本内容
2. 多行注释
/*
*
* 文本内容
*
*/
3. 文档注释
注释编写方法
/**
*
* @author jackson
* @version 1.0
*
*/文档注释生成命令
javadoc -d （保存文件路径） -xx -yy 文件名.java
说明：-xx,-yy是javadoc 标签
举例
javadoc -d C:\Users\jackson\Desktop\code -author -version comment.java
javadoc 标签参考
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author description |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| @docRoot | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| @inheritDoc | 从直接父类继承的注释 | Inherits a comment from the immediate superclass |
| @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 info |