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

相关推荐
Hello eveybody4 分钟前
介绍一下背包DP(C++)
开发语言·c++·动态规划·dp·背包dp
2401_8788204725 分钟前
Sa-Token基础篇
java·spring boot·后端·sa-token
2301_8163743328 分钟前
Nginx下构建PC站点
java·运维·nginx
Run_Teenage34 分钟前
Linux:线程互斥,线程锁
运维·开发语言·jvm
小小de风呀37 分钟前
de风——【从零开始学C++】(四):类和对象(下)
开发语言·c++·算法
无所事事O_o37 分钟前
JAVA应用不定时卡顿问题排查过程记录
java·优化
覆东流38 分钟前
第10天:python元组
开发语言·后端·python
CSCN新手听安39 分钟前
【Qt】系统相关(一)内容简介,事件概念,事件的处理
开发语言·c++·qt
不想写代码的星星1 小时前
重识 std::tuple:一个被低估的编译期异构容器
开发语言·c++
幸福巡礼1 小时前
【LangChain 1.2 实战(八)】Agent Middleware 实战 —— 动态路由、监控、安全与容错
java·安全·langchain