Java注释Java中的注释主要分为三类类型语法用途单行注释// 注释内容对代码进行简短说明编译时忽略多行注释/* 注释内容 */可跨行用于较长的解释或临时屏蔽代码块文档注释/** 注释内容 */Java独有用于生成API文档可包含HTML标签和标签2.1 单行注释//这是一个Java类public class CommentTest {//main()方法Java程序的主入口public static void main(String[] args) {System.out.println(Hello World!); //这是一个打印输出语句}}2.2 多行注释/*这是一个多行注释可以在这里声明多行注释的信息1. Java中有三种注释格式单行注释、多行注释、文档注释Java独有2. 单行注释、多行注释的作用① 对程序中的代码进行解释说明。② 可以注释可能存在错误的代码方便程序进行调试。3. 注意① 单行注释和多行注释中声明的信息不参与编译。即编译后生成的字节码文件中不包含注释内容。② 多行注释不能嵌套使用。*/public class CommentTest {public static void main(String[] args){System.out.println(Hello World!);}}查看源文件被编译后的字节码文件中单行注释和多行注释是否被编译如图所示注释没有被Java编译器进行编译。2.3 文档注释Java独有。文档注释内容可以被JDK提供的文档生成工具javadoc解析生成一套以网页文件HTML形式体现的该程序的说明文档。1. 文档注释常用标签标签描述适用位置author作者类、接口version版本类、接口param参数说明方法、构造器return返回值说明方法throws / exception抛出的异常方法、构造器see参考链接任意since从哪个版本开始类、方法、字段deprecated已过时类、方法、字段2. javadoc 工具的使用示例使用的源文件CommentTest.java内容/**文档注释文档注释内容可以被JDK提供的javadoc工具解析生成一套以网页文件形式体现的该程序的说明文档。author Evanversion 1.0*/public class CommentTest {public static void main(String[] args) {System.out.println(Hello World!);}}基本命令格式:javadoc [选项] [包名] [源文件名]常用选项选项说明-d 目录指定生成的HTML文档存放目录-author包含author信息-version包含version信息-encoding源文件编码如UTF-8-charset生成的HTML文档字符集-private显示所有类和成员默认只显示public和protected示例1:为源文件生成HTML文档打开cmd命令行终端切换到源文件所在目录。执行命令javadoc -d mydoc -encoding gbk -charset gbk -version -author CommentTest.java-d mydoc将生成的文档放到mydoc目录下。-author -version在文档中显示作者和版本信息。-encoding gbk -charset gbk指定源文件的字符编码和生成后HTML文件的字符编码。-charset utf-8 指定生成的 HTML 文档的字符集。忽略编码参数如果不指定-encoding时javadoc会使用系统默认字符编码Windows 上通常是 GBKLinux/macOS 是 UTF-8这样可能在跨平台时出现乱码因此不推荐。在../mydoc/index.html即可查看生成的API文档。示例2为整个包生成HTML文档javadoc -d mydoc -author -version com.example.utils3. 常见问题使用javadoc -encoding utf-8出现错误:编码utf-8的不可映射字符原因分析这个错误通常是因为 源文件的实际编码 与 -encoding 指定的编码不一致导致的。javadoc 尝试用 UTF-8 读取文件但源文件中存在不符合 UTF-8 格式的字节比如用 GBK 保存的中文字符于是报“不可映射字符”。解决方案确认源文件的真实编码方式1用记事本打开源文件点击“另存为”查看右下角的编码。方式2在 Windows 上打开cmd命令行使用chcp命令 查看活动代码页。根据实际编码调整-encoding参数如果源文件是 GBK 编码将命令改为javadoc -d mydoc -encoding gbk -charset utf-8 CommentTest.java如果源文件是 UTF-8但可能带有 BOM也可以继续用 -encoding utf-8但建议确保文件是无 BOM 的 UTF-8。将源文件统一转为 UTF-8推荐用文本编辑器如 VS Code、Notepad将源文件另存为 UTF-8 无 BOM 格式。之后就可以放心使用javadoc -encoding utf-8 -charset utf-8 CommentTest.java