Java基础——注释

在开发中注释是必不可少的,帮助我们更好的标记阅读代码,下面介绍几种常用的注释方式。

一、注释种类

1. 单行注释

使用//一行代码来进行注释,只能注释一行内容

2. 多行注释

使用斜杠+星号的方式 /*注释多行代码*/,注释多行代码

3. 文档注释

使用/**文档注释内容*/ 来注释文档内容,一般文档注释用于类、方法、成员变量上

二、JavaDoc

Javadoc 是 Sun 公司提供的一种工具,通过JavaDoc我们可以生成一个源码对应的帮助文档。

1. 常见标签

JavaDoc工具定义了一些识别注释标签,常用的标签如下:

  • @author:标识一个类的作者,一般用于类注释
  • @exception可能抛出异常的说明,一般用于方法注释
  • @param:说明一个方法的参数,一般用于方法注释
  • @return:说明返回值类型,一般用于方法注释,不能出现再构造方法中
  • @throws:和 @exception 标签一样
  • @version :指定类的版本,一般用于类注释

2. 用法命令

通过javadoc -help命令我们可以查看用法帮助

3.类的javaDoc注释

4.方法的JavaDoc注释

4.变量的JavaDoc注释

相关推荐
云烟成雨TD13 小时前
Spring AI Alibaba 1.x 系列【6】ReactAgent 同步执行 & 流式执行
java·人工智能·spring
Wenweno0o13 小时前
0基础Go语言Eino框架智能体实战-chatModel
开发语言·后端·golang
于慨13 小时前
Lambda 表达式、方法引用(Method Reference)语法
java·前端·servlet
swg32132113 小时前
Spring Boot 3.X Oauth2 认证服务与资源服务
java·spring boot·后端
gelald14 小时前
SpringBoot - 自动配置原理
java·spring boot·后端
殷紫川14 小时前
深入理解 AQS:从架构到实现,解锁 Java 并发编程的核心密钥
java
一轮弯弯的明月14 小时前
贝尔数求集合划分方案总数
java·笔记·蓝桥杯·学习心得
chenjingming66614 小时前
jmeter线程组设置以及串行和并行设置
java·开发语言·jmeter
殷紫川14 小时前
深入拆解 Java volatile:从内存屏障到无锁编程的实战指南
java
eddieHoo14 小时前
查看 Tomcat 的堆内存参数
java·tomcat