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注释

相关推荐
Hiter_John1 分钟前
Golang的循环语句
开发语言·算法·golang
右耳朵猫AI5 分钟前
Java/JVM周刊2026W21 | Java 26发布、JDK 27抢先体验、Spring Boot 4.1预告、GlassFish 8.0.2发布
java·jvm·spring boot
Knight_AL7 分钟前
MyBatis 报错:Parameter ‘xxx‘ not found 的原因与解决方案
java·tomcat·mybatis
绍磊leo9 分钟前
Go 实现类似 FastAPI 的后端服务:从入门到实战
开发语言·golang
一条泥憨鱼9 分钟前
Java网络编程:Socket通信从入门到起飞
java·开发语言·网络·网络编程
磊 子10 分钟前
STL算法库讲解1
开发语言·c++·算法
Hiter_John10 分钟前
Golang的条件判断
服务器·开发语言·golang
276695829211 分钟前
谷歌google cookie逆向角度分析
开发语言·python·google·sgss·谷歌搜索·sg-ss·谷歌cookie逆向
西安邮电大学14 分钟前
分布式锁三种实现
java·redis·后端·其他·面试
码不停蹄的玄黓18 分钟前
SpringBoot 实现自定义注解
java·spring boot·spring