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

相关推荐
Flynt8 分钟前
Spring Boot 3开虚拟线程,我把生产服务搞崩了两次
java·spring boot
SimonKing18 分钟前
别再盲目跑测试了,用 JaCoCo 告诉你哪些代码根本没被覆盖
java·后端·程序员
吃好睡好便好19 分钟前
MATLAB中图像格式的转换
开发语言·图像处理·学习·计算机视觉·matlab
唐青枫23 分钟前
Java Grails 实战详解:用 Groovy 和 GORM 快速开发 Web 应用
java·groovy
SemiTris25 分钟前
Java 异常体系深度解析:从误区到精通
java
爱喝水的鱼丶29 分钟前
SAP-ABAP:SELECT大数据量查询性能调优——避免嵌套循环、减少数据库交互的核心方案
开发语言·数据库·sql·性能优化·sap·abap·erp
Dxy123931021631 分钟前
Python 实现POST上行压缩上传可用HTTP库汇总
开发语言·python·http
荣码36 分钟前
AI应用部署上线:Docker打包+API服务+监控告警,我踩了4个坑
java·python
郝学胜-神的一滴42 分钟前
Python 高级编程 026:序列内核深剖
开发语言·python·程序人生·软件工程