Java代码注释类型及使用详解
代码注释
注释（comment）是用于说明解释程序的文字，注释的作用在于提高代码的阅读性（可读性）。Java中的注释类型包括3种，分别是：
- 单行注释
- 多行注释
- 文档注释
❤️ 单行注释
基本格式：// 注释文字
// Comment
💙 多行注释
基本格式：/* 注释文字 */
使用细节：多行注释里面不允许多行注释嵌套！
/*
Comment
...
*/
💚 文档注释
类型说明：注释内容可以被JDK提供的javadoc所解析，生成一套以网页文件形式体现的程序说明文档。
/**
* @author xxx
* @version 1.0
* Doc Comment
*/
基本格式：每个/** */文档注释包含标记以及之后紧跟着的自由格式文本（free-form text）。标记以@开头，自由格式文本用于描述，可以使用HTML修饰符，比如用于强调的<em>...</em>。
使用细节：没有必要在每行开始都添加*，不过大部分IDE会自动提供*。
/**
@author xxx
@version 1.0
Doc Comment
*/
使用过程：
-
类注释：必须方在
import语句之后，class定义之前。 -
方法注释：必须放在所描述的方法之前，除通用标记外，还有
@param、@return和@throws。 -
字段注释：只需对公共字段（通常指静态常量）添加文档注释。
-
通用注释：包括
@since、@author、@version、@see和@link（@see和@link可以使用超链接）。 -
包注释：需要在每个包目录中添加单独的文件（有
package-info.java和package.html两种方式）。注意：package-info.java文件必须包含一个初始的Javadoc注释，以/** */界定，后面是一个package语句，且不包含其他内容；package.html中<body>...</body>之间的所有文本为注释内容。
注释提取：将生成的网页文件放在指定文件夹下
javadoc -d 文件夹名 -xx -yy demo.java
其中，xx和yy可以是author、version等Java doc标记，表示要生成的标记。
扫一扫
1424
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
