什么是java注释文档

Java有三种注释方式： 1、 // String a = "a"; 2、 / String b = "b"; String c = "c"; / 3、 / String d = "d"; String e = "e"; / 其中1和2是一样的，但1只是注释一行；2可以注释多行 3除了可以注释多行外，并且可以用JDK中的javadoc生成文档，Java的API document就是用javadoc生成的JDK源码中的第三类注释。所以第3类注释可以称之为注释文档。

希望采纳

（1）单行注释：以“ // ”开头后面接所要加的说明的内容。如下面所示： //定义变量a int a = 10; //定义变量b int b = 20;上面的语句中，在编译的过程就会直接略过注释，只会编译 int a = 10 和 int b = 20这两句。由此可见注释只是起着说明的作用。

（2）多行注释：以“/”开头，以“/”结尾。 假设当你要说明你所写的代码的功能时。要说明的内容有很多。如果全部放在同一行会显得很难看。所以一般会用多行来写，如下所示// 说明//说明//说明//说明以上是用四个单行注释来注释四行说明。但如果有10行说明就要按十个“//”这显示很麻烦，所以这时就可采用多行注释。上面的可改成：/说明说明说明说明/也可以这样/ 说明 说明 说明 说明 /

（3）文档注释：以“/”开头，以“/”结尾。文档注释主要是生成文档的。

//看例子

import javautilArrayList;

public class Hi

{

public static void main(String[] args)

{

}

}

/将文档注释放在这些地方

将文档注释放在这些地方

将文档注释放在这些地方

将文档注释放在这些地方/

class Stu

{

Stu(int id,String n)

{

thisid=id;

thisname=n;

}

int id;

String name;

}

注释符就是用来标记注释的符号，Java中有3种注释符号

1 单行注释：

从“//”开始到行末结束，均视为单行注释。

2 多行注释：

从“/”开始到“/”结束，均视为多行注释。

3 文档注释：

从“/”开始到“/”结束，均视为文档注释。

所谓文档注释，是指用javadoc命令可以提取为Java API文档的注释内容，也就是类的注释和方法的注释。

Java中没有标识符的概念，有标识的概念。标识是指包名、类名、方法名、变量名、参数名。在你的代码中，比如类名 slra、方法名 main、参数名 args，这些是标识

JAVA 的注释大致分为3块

1、行注释

就是在一行的最前端 写上 “//”

2、块注释

就是在要注释的代码块的前面加上 “/”在结尾加上“/”

3、文档注释

文档注释一般用于方法或类上

常用Java注释标签（Java comment

tags）

@author 作者

适用范围：文件、类、方法

（多个作者使用多个@author标签标识，java

doc中显示按输入时间顺序罗列。）

例：

@author Leo Yao

@param 输入参数的名称 说明

适用范围：方法

例： @param str

the String用来存放输出信息。

@return 输出参数说明

适用范围：方法

例：

@return <code>true</code>执行成功;

<code>false</code>执行失败

@since

JDK版本

用于标识编译该文件所需要的JDK环境。

适用范围：文件、类

例： @since

JDK16

@version 版本号

用于标识注释对象的版本号

适用范围：文件、类、方法

例： @version 10

@see 链接目标

表示参考。会在java 文档中生成一个超链接，链接到参考的类容。使用中的感觉是@see不需要包路径，对我这种懒人比较喜欢，相对{@link

}这种既要加大括号，有需要包路径，我还是选择偷懒，当然你要是不介意使用import导入要link的类，那就可以达到@see的效果，所以总体来说，还是选择@see，当然两个在特殊场合下还是用法不一样的

用法：

@see

#field

@see #Constructor(Type,

Type)

@see #Constructor(Type id, Type

id)

@see #method(Type,

Type,)

@see #method(Type id, Type,

id)

@see

Class

@see

Class#field

@see Class#Constructor(Type,

Type)

@see Class#Constructor(Type id,

Type id)

@see Class#method(Type,

Type,)

@see Class#method(Type id, Type

id,)

@see

packageClass

@see

packageClass#field

@see

packageClass#Constructor(Type, Type)

@see

packageClass#Constructor(Type id, Type id)

@see packageClass#method(Type,

Type,)

@see packageClass#method(Type

id, Type, id)

@see

package

@throws 异常

标识出方法可能抛出的异常

适用范围：方法

例： @throws IOException If an input or output

exception occurred

@deprecated 解释

标识对象过期

适用范围：文件、类、方法

@link 链接地址

链接到一个目标，用法类似@see。但常放在注释的解释中形如{@link …}

例：

/

@deprecated As of JDK 11,

replaced by

{@link

#setBounds(int,int,int,int)}

/

以上就是关于什么是java注释文档全部的内容，包括:什么是java注释文档、Java如何进行单行注释和多行注释、如何写Java文档注释等相关内容解答，如果想了解更多相关内容，可以关注我们，你们的支持是我们更新的动力！