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

相关推荐
TH_116 分钟前
4、前台界面,表格列名写错
java
syt_101323 分钟前
grid布局之-子项放置4
开发语言·javascript·ecmascript
喵了meme25 分钟前
C语言实战2
c语言·开发语言·网络
charlie11451419132 分钟前
现代C++工程实践:简单的IniParser3——改进我们的split
开发语言·c++·笔记·学习
fish_xk33 分钟前
c++的引用和类的初见
开发语言·c++
没有bug.的程序员38 分钟前
高频IO服务优化实战指南
java·jvm·spring·容器
yong999038 分钟前
水箱水位控制系统MATLAB实现
开发语言·matlab
通往曙光的路上39 分钟前
授权vvvvvv
java·开发语言·windows
Data_agent40 分钟前
京东商品视频API,Python请求示例
java·开发语言·爬虫·python
a努力。44 分钟前
HSBC Java面试被问:CAS如何解决ABA问题
java·开发语言·面试