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

相关推荐
seven97_top2 分钟前
Tomcat的架构设计和启动过程详解
java·tomcat
qq_254617777 分钟前
attribute((constructor)) 在C/C++中的应用
开发语言·c++
xyq202410 分钟前
HTML5 Input 类型详解
开发语言
云深麋鹿11 分钟前
C++ | 多态
开发语言·c++
我是无敌小恐龙15 分钟前
Java SE 零基础入门 Day05 类与对象核心详解(封装+构造方法+内存+变量)
java·开发语言·人工智能·python·机器学习·计算机视觉·数据挖掘
逻辑驱动的ken21 分钟前
Java高频面试考点14
开发语言·数据库·算法·哈希算法
小灰灰搞电子23 分钟前
Python self关键字详解及其应用
开发语言·python
故事还在继续吗24 分钟前
C++17关键特性
开发语言·c++·算法
va学弟27 分钟前
Agent入门开发(2):个性化功能添加
java·服务器·ai
84869811928 分钟前
Cursor 用 Java + Vue3 做了一个可落地的酒店管理系统(HMS),支持多门店、RBAC、财务结算,源码开源!
java·开发语言·开源