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

相关推荐
C***1150几秒前
对基因列表中批量的基因进行GO和KEGG注释
开发语言·数据库·golang
6***09262 分钟前
如何快速搭建简单SpringBoot项目网页
java·spring boot·intellij-idea
q***448111 分钟前
spring实例化对象的几种方式(使用XML配置文件)
xml·java·spring
q***985213 分钟前
Spring Boot:Java开发的神奇加速器(二)
java·spring boot·后端
x***440121 分钟前
Windows操作系统部署Tomcat详细讲解
java·windows·tomcat
小蒜学长26 分钟前
基于spring boot的汽车4s店管理系统(代码+数据库+LW)
java·数据库·spring boot·后端·汽车
q***420528 分钟前
Spring Data 什么是Spring Data 理解
java·后端·spring
一 乐29 分钟前
餐厅管理智能点餐系统|基于java+ Springboot的餐厅管理系统(源码+数据库+文档)
java·前端·数据库·vue.js·spring boot·后端
Percep_gan31 分钟前
解决java.security.InvalidKeyException: Illegal key size
java·开发语言
likuolei1 小时前
XQuery 完整语法速查表(2025 最新版,XQuery 3.1)
xml·java·数据库