Java 文档注释速查手册
首页
›
Java手册
›
Java 文档注释
› 语法规则
Java
文档注释
:/**开始:📐三条写法约定
三条写法约定。
图 3:Java 文档注释:/**开始(1080×1440 速查卡片)
📐三条写法约定
① 以 /** 开始,以 */ 结束
② 每行以 * 开头(美观,非强制)
③ 注释里支持 HTML 标签,
如 <p>、<br>、<code>、<b>
📝第一段是主要描述
在开始的 /** 之后,
第一行或几行是关于类、变量和方法的
主要描述。
⚠️ @ 标签必须换行
之后可以包含一个或多个 @ 标签。
每一个 @ 标签必须在一个新行的开始,
或者在一行的开始紧跟星号 *。
🧩同类标签放一组
多个相同类型的标签应该放成一组。
例如如果有三个 @see 标签,
就把它们一个接一个放在一起。
2. 总览
4. 语法规则
5. 常用标签
6. 进阶标签
7. 完整示例
8. 完整示例
9. 生成文档
10. 总结
11. 总结
12. 总结
13. 总结
← 上一篇
总览
下一篇 →
语法规则
Java Applet
Java 常用类库
Java 9 新特性
Java MySQL 连接
Java 8 新特性
Java 实例
Java 多线程
Java 发送邮件
Java 网络编程
Java 序列化
Java 泛型
Java NIO Files
Java Object 类
Java 迭代器
Java HashMap
Java HashSet
Java LinkedList
Java ArrayList
Java 集合框架
Java 数据结构
Java 封装
Java 接口
Java 枚举
Java 包
Java 反射
Java 抽象类
Java 多态
Java 重写与重载
Java 继承
Java 异常处理
Java StringBuffer
Java String
Java Character
Java Number & Math
Java 正则表达式
Java 日期时间
Java 数组
Java 方法
Java 流与文件IO
Java Scanner 类
Java 构造方法
Java 条件语句
Java 循环结构
Java switch case
Java 运算符
Java 修饰符
Java 变量命名规则
Java 变量类型
Java 基本数据类型
Java 对象和类
Java 注释
Java 基础语法