在开发中注释是必不可少的,帮助我们更好的标记阅读代码,下面介绍几种常用的注释方式。
一、注释种类
1. 单行注释
使用//一行代码
来进行注释,只能注释一行内容
2. 多行注释
使用斜杠+星号的方式 /*注释多行代码*/
,注释多行代码
3. 文档注释
使用/**文档注释内容*/
来注释文档内容,一般文档注释用于类、方法、成员变量上
二、JavaDoc
Javadoc 是 Sun 公司提供的一种工具,通过JavaDoc我们可以生成一个源码对应的帮助文档。
1. 常见标签
JavaDoc工具定义了一些识别注释标签,常用的标签如下:
- @author:标识一个类的作者,一般用于类注释
- @exception可能抛出异常的说明,一般用于方法注释
- @param:说明一个方法的参数,一般用于方法注释
- @return:说明返回值类型,一般用于方法注释,不能出现再构造方法中
- @throws:和 @exception 标签一样
- @version :指定类的版本,一般用于类注释
2. 用法命令
通过javadoc -help
命令我们可以查看用法帮助