Java 注释速查手册

Java 注释速查手册

把 Java 三种注释压成 8 张卡片：什么是注释、单行 //、多行 /* */、文档 /** */ 与 javadoc 工具、17 个标签上下两页速查、以及 @return void 报错和多行注释嵌套两大避坑。点击任意卡片进入完整图文详解。

这套手册讲什么

注释是源码中解释代码作用的文本，不会被编译器包含在最终程序中
涵盖 Java 三种注释方式：单行 //、多行 /* */、文档 /** */
javadoc 工具用法与 17 个标签完整速查（@author @param @return @throws @see @since @deprecated 等行内标签）
两个最常见坑：@return 用在 void 上、多行注释嵌套错误

Java 注释总览

Java 注释总览

8 张图系统梳理 Java 三种注释方式、javadoc 工具用法与 17 个标签速查表，以及 @ret…

Java 注释是什么

Java 注释是什么

详解 Java 注释的定义与核心价值：注释是源码中解释代码作用的文本，增强程序可读性和可维护性，不会被编…

Java 单行注释

Java 单行注释

Java 单行注释以双斜杠开始，从注释符到本行行尾的内容全部被编译器忽略。适用于简短说明、行尾补充和临时…

Java 多行注释

Java 多行注释

Java 多行注释以 /* 开始、以 */ 结束，中间所有内容都被忽略。适用于大段文字说明、文件头版权声…

Java 文档注释与 javadoc

Java 文档注释与 javadoc

Java 文档注释以 /** 开始、以 */ 结束，写在类、方法、字段声明前面，可被 javadoc 工…

javadoc 常用标签（上）

javadoc 常用标签（上）

javadoc 高频标签（上篇）：@author 标识作者、@version 指定版本、@param 说…

javadoc 进阶标签（下）

javadoc 进阶标签（下）

javadoc 进阶标签（下篇）：行内链接、纯文本链接、文档根路径、继承父类注释、显示常量值，以及 @s…

javadoc 输出与常见坑

javadoc 输出与常见坑

javadoc 工具把 Java 源码作为输入，输出含注释的 HTML 文件、继承树形结构与索引。总结 …