1.什么是注释?java
- 用以描述某段代码的做用。
2.注释的三种类型:blog
- 单行注释、多行注释、文档注释。以下图所示:
3.咱们能够经过 javadoc 命令从文档注释中提取内容,生成程序的 API 帮助文档。开发
4.打开首页,查看下生成的 API 文档:文档
PS:使用文档注释时还能够使用 javadoc 标记,生成更详细的文档信息:io
@author 标明开发该类模块的做者class
@version 标明该类模块的版本exception
@see 参考转向,也就是相关主题程序
@param 对方法中某参数的说明方法
@return 对方法返回值的说明im
@exception 对方法可能抛出的异常进行说明