三种注释:
- // 用于单行注释。
- /…/ 用于多行注释,从/开始,到/结束,不能嵌套。
- /**…*/ 则是为支持 jdk 工具 javadoc.exe 而特有的注释语句
常用的Javadoc标记
- @author 指定Java程序的作者
- @version 指定源文件版本
- @parameter 参数名及其意义
- @return 返回值
- @throws 异常类及抛出条件
- @deprecated 引起不推荐使用的警告(标识一个方法已经不推荐使用了)
- @see “参见”,指定交叉参考的内容
- @since 表示从那个版本起开始有了这个函数
- @note 表示注解,暴露给源码阅读者的文档
- {@value} 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。
- {@link包.类#成员} 链接到某个特定的成员对应的文档中。
Javadoc与html
由于Javadoc生成的是html的样式,所以在文档注释中支持部分html的标签。
段落级标签
- 段落:
用于标记段落的开始,段落结束
- 换行:
- 预格式化标签:
文本格式化标签
- 标签
该文本将以粗体显示 - 标签
该文本将以斜体显示 - 标签
该文本的显示高度将低于前后的文本 - 标签
该文本的显示高度将高于周围的文本 -
标签 定义长的引用,