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

相关推荐
秋饼11 分钟前
MySQL 分库分表完全指南:ShardingSphere-JDBC 实战、分片键选型、场景边界、20 个生产坑与 30 道面试点
java·mysql·面试·shardingsphere·分库分表·后端架构
郭小李16 分钟前
spring 的 @CookieValue 注解 用法
java·后端·spring
天远Date Lab25 分钟前
零信任架构实战:基于天远企业股权变更构建自动化招投标供应商股东穿透审查网关
java·人工智能·架构·自动化
蘑菇小白32 分钟前
Linux多线程开发
linux·开发语言·线程
2601_9669496544 分钟前
Python 实战:如何统计五档盘口买卖盘总挂单量?附计算公式与代码
开发语言·python·数据分析·pandas·量化交易·股票数据·quantdash
weixin_399380691 小时前
TongWeb7.0.4.9M11如何接入到idea(by lqw)
java·ide·intellij-idea
paopaokaka_luck1 小时前
社区服务平台(加权协同过滤推荐、Jieba中文词频分析、WebSocket实时聊天、求助处理闭环、 活动积分闭环、ECharts多维分析)
java·前端·spring boot·mysql·echarts·mybatis
.Bryce.1 小时前
T2-LLM评测不等于Agent评测
android·java·人工智能·后端·gpt·agent·1024程序员节
Wang's Blog1 小时前
Java 项目实战: 交友项目 - 用户体系集成:查询用户环信账号密码
java·交友
全栈陈序员1 小时前
【Python】基础语法入门(二十九)—— 正则表达式实战:文本处理利器
开发语言·人工智能·python·正则表达式