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

相关推荐
2501_913061342 分钟前
JVM虚拟机——面试中的八股文
java·jvm·面试
A-Jie-Y3 分钟前
JAVA设计模式-单例模式
java·设计模式
编程之升级打怪3 分钟前
设计模板引擎类的主要接口
java
ffqws_10 分钟前
Spring Boot 整合 PageHelper 实现分页查询
java·spring boot·mybatis
大龄码农-涵哥13 分钟前
Java调用AI大模型API入门:从零开始接入ChatGPT/通义千问
java·人工智能·chatgpt
ch.ju13 分钟前
Java程序设计(第3版)第二章——for嵌套输出图形
java
XiYang-DING16 分钟前
【Java EE】工厂模式
java·python·java-ee
龙俊杰的读书笔记17 分钟前
一文读懂python并发&并行编程--以xinference框架应用为例
开发语言·网络·python
liulilittle19 分钟前
递归复制搜索所有的lua文件到指定目录
java·开发语言·lua·cmd
Gofarlic_oms130 分钟前
Allegro高级功能模块许可证管理注意事项
运维·服务器·开发语言·matlab·负载均衡