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

相关推荐
w_zero_one36 分钟前
递归算法(一)
java·开发语言·算法
SL_staff1 小时前
私有化低代码不是减配版开发:JVS双模式建模如何重建IT交付信任
java·低代码·spring cloud
墨着染霜华1 小时前
Redocly 生成 OpenAPI 接口文档踩坑实录|Node 版本兼容 + 接口地址错误问题解决
java
文丑颜不良啊1 小时前
LeetCode1881~1990题目解析
java·leetcode
Julien20042 小时前
管理机密(一)
运维·服务器·开发语言·学习方法
Chen_harmony2 小时前
七、STL与string类
开发语言·c++
沐晓时光2 小时前
C语言入门,字符串和字符串函数知识讲解
c语言·开发语言
xxxiugou1232 小时前
C++命名空间与引用全解析
开发语言·c++
十碗饭吃不饱2 小时前
后端运维:网络联通、进程查询、Java服务启动脚本
java·运维·网络
T_Wizard2 小时前
后端转 AI 应用开发,我先把这 12 个名词理清了:一张图看懂架构、RAG、Tool Calling 与 MCP
java·ai编程