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

相关推荐
DevilSeagull3 分钟前
MySQL(1) 安装与配置
java·数据库·git·mysql·http·开源·github
季明洵3 分钟前
Java基础---逻辑控制(上)
java·开发语言·循环结构·分支结构·顺序结构
Cyan_RA94 分钟前
如何利用 Paddle-OCR 丝滑进行复杂版面 PDF 的批量化OCR处理?
java·linux·python·ocr·conda·paddle·surya
程序员清风5 分钟前
2026年AI编程工具对比:谁最值得用?
java·后端·面试
希望永不加班6 分钟前
SpringBoot 多级缓存(本地缓存 + Redis)
java·spring boot·redis·后端·缓存
沫璃染墨7 分钟前
重生之我要手写 C++ list:从底层结构到 const 迭代器与迭代器失效全解
开发语言·c++
C雨后彩虹8 分钟前
文件目录大小
java·数据结构·算法·华为·面试
0南城逆流011 分钟前
【技术点】嵌入式技术考点三:数据结构
java·数据结构·算法
练习时长一年15 分钟前
xlsx文件下载异常问题
java·开发语言
secret_to_me17 分钟前
裴行俭VS袁天罡和李淳风
开发语言