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

相关推荐
对酒当歌丶人生几何1 分钟前
Spring异步体系与事务一致性实战指南
java·spring·eventlistener
leo__5202 分钟前
基于C#与HALCON开发的完整视觉检测系统案例
开发语言·c#·视觉检测
这也能行4 分钟前
Tomcat
java·tomcat
小杍随笔4 分钟前
【Rust中所有符号的作用及使用场景详解】
java·算法·rust
亚马逊云开发者4 分钟前
别再烧 Token 了!我用这 5 个配置把 OpenClaw 费用砍了一半
java
yeshihouhou5 分钟前
redisson实现延迟队列
java·前端·数据库
猿饵块6 分钟前
python--sys
开发语言·python
故河7 分钟前
Python工具:Conda 包管理器
开发语言·python·conda
明码9 分钟前
Pathlib库
java·服务器·前端
亦复何言??9 分钟前
ROS2 节点使用 Conda 环境运行 Python 依赖的解决方案
开发语言·python·conda