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

相关推荐
AA陈超4 小时前
CN-Language中文编程语言:第03篇-语法基础
开发语言·cn·cn中文编程语言·cn-language
熊猫钓鱼>_>4 小时前
CMP for OpenHarmony 实战:Coil 图片加载库鸿蒙化使用心得
运维·服务器·开发语言·华为·ai编程·harmonyos·openharmony
fengci.4 小时前
CTF2刷题记录(困难部分)
android·开发语言·前端·学习·php
可乐_不渴4 小时前
【Linux】 进程虚拟地址空间
java·linux·javascript
SimonKing4 小时前
号外号外,Stream-Nexus推送项目支持集群部署了
java·后端·程序员
老王IT4 小时前
Rust开发环境搭建教程
开发语言·后端·rust
vipxieliang4 小时前
ValidX vs 正则表达式:可读性与维护性对比
java·spring boot
337804 小时前
5分钟搞懂登录认证和授权框架Spring Security
java·spring boot
vipxieliang4 小时前
Spring Security 6.x 实战:认证、授权与 JWT 集成
java·spring boot
world78112264 小时前
【C++】set 和 map
java·前端·c++·set·map