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

相关推荐
书源丶20 分钟前
四十三、网络编程(下)——TCP 编程与 HTTP 入门
java·网络·tcp/ip·http
木井巳21 分钟前
【递归算法】单词搜索
java·算法·leetcode·决策树·深度优先
阿豪只会阿巴40 分钟前
【没事学点啥】TurboBlog轻量级个人博客项目——Turbo Blog 项目学习与上线指南
开发语言·python·学习·状态模式
幸运的大号暖贴42 分钟前
解决Vibe Coding时Idea经常不自动git add问题
java·人工智能·git·intellij-idea·claudecode·opencode
m0_716255001 小时前
第一部分 数据开发 面试全题 模拟口述版(自问自答)
java·数据库·面试
L-影1 小时前
常见的 ORM 工具
开发语言·数据库·fastapi·orm
飞Link1 小时前
构筑你的数字第二大脑:Obsidian 深度解析与配置指南
开发语言·python
SuperherRo1 小时前
服务攻防-Java组件安全&FastJson&高版本JNDI&不出网C3P0&编码绕WAF&写入文件CI链
java·安全·fastjson·waf·不出网·高版本·写入文件
丑八怪大丑1 小时前
SQL数据类型
java·数据库·sql
Nyarlathotep01131 小时前
并发集合类(3):LinkedBlockingQueue
java·后端