java三种注释
1.单行注释
//注释内容
2.多行注释
/*
*注释内容
*/
3.文档注释javadoc注释
/**
*注释内容
*/
javaDoc注释介绍
JavaDoc 标 记 | 解释 |
@version | 指定版本信息 |
@since | 指定最早出现在哪个版本 |
@author | 指定作者 |
@see | 生成参考其他的JavaDoc文档的连接 |
@link | 生成参考其他的JavaDoc文档,它和@see标记的区别在于,@link标记能够嵌入到注释语句中,为注释语句中的特殊词汇生成连接。 eg.{@link Hello} |
@deprecated | 用来注明被注释的类、变量或方法已经不提倡使用,在将来的版本中有可能被废弃 |
@param | 描述方法的参数 |
@return | 描述方法的返回值 |
@throws | 描述方法抛出的异常,指明抛出异常的条件 |
注意:
(1)javadoc针对public类生成注释文档
(2)javadoc只能在public、protected修饰的方法或者属性之上
(3)javadoc注释的格式化:前导*号和HTML标签
(4)javadoc注释要仅靠在类、属性、方法之前
第三种注释的应用:
(1)首先编写.java文件
(2)在命令行中执行以下dos命令:
javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档
//javadoc标记:是@开头的,对javadoc而言,特殊的标记。
(3)在当前目录下就会产生doc文件夹,里面有一系列的.html文件