Java 文档注释速查手册
首页
›
Java手册
›
Java 文档注释
› 语法规则
Java
文档注释
:/**开始:ClassDoc.java
三条写法约定。
图 4:Java 文档注释:/**开始(1080×1440 速查卡片)
ClassDoc.java
/**
* 这个类绘制一个条形图
* @author runoob
* @version 1.2
*/
public class BarChart {
// ...
}
👤@author 与 @version
@author 标识一个类的作者
@version 指定类的版本
两者都用在类级注释上。
📥@param 与 @return
@param 说明一个方法的参数
格式:@param 参数名 说明
@return 说明返回值类型与含义
2. 总览
3. 语法规则
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 基础语法