Java中由三种注释方式
单行注释 使用//
对某一句内容进行解释时使用多行注释或者单行注释比如
public class Hello{//public代表公开的权限最大的
public static void main(String[] args){
System.out.println("Hello World!");
}
}
多行注释 使用 /* */
对某一句内容进行解释时使用多行注释或者单行注释比如
public class Hello{
public static void main(String[] args){
/*
out输出
println打印
这条语句可以打印输出Hello World!
*/
System.out.println("Hello World!");
}
}
文档注释 使用/** */
第三种被称作说明注释,它以 /** 开始,以 */结束。说明注释允许你在程序中嵌入关于程序的信息。比如
/**这是程序的入口
* @author qingsu
*/
public class Hello{
public static void main(String[] args){
System.out.println("Hello World!");
}
}
其中文档注释包含很多标签 主要有以下
标签 | 描述 |
---|---|
@author | 标识一个类的作者 |
@deprecated | 指名一个过期的类或成员 |
{@docRoot} | 指明当前文档根目录的路径 |
@exception | 标志一个类抛出的异常 |
{@inheritDoc} | 从直接父类继承的注释 |
{@link} | 插入一个到另一个主题的链接 |
{@linkplain} | 插入一个到另一个主题的链接,但是该链接显示纯文本字体 |
@param | 说明一个方法的参数 |
@return | 说明返回值类型 |
@see | 指定一个到另一个主题的链接 |
@serial | 说明一个序列化属性 |
@serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 |
@serialField | 说明一个ObjectStreamField组件 |
@since | 标记当引入一个特定的变化时 |
@throws | 和 @exception标签一样. |
{@value} | 显示常量的值,该常量必须是static属性。 |
@version | 指定类的版本 |