JAVA入门第一季-7.JAVA中的注释

本文介绍了Java中的三种注释类型:单行注释、多行注释及文档注释,并详细解释了如何使用文档注释来生成API帮助文档,包括各种javadoc标记的用法。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Java 中注释有三种类型:单行注释、多行注释、文档注释

1>注释示例
注释示例

2>生成API(未测试)
我们可以通过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。
api

打开首页,查看下生成的 API 文档
这里写图片描述

PS:使用文档注释时还可以使用 javadoc 标记,生成更详细的文档信息:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值