java注释@para_Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等...

匿名用户

1级

2014-12-10 回答

常用Java注释标签(Java comment

tags)

@author 作者

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

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

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

例：*

@author Leo. Yao

@param 输入参数的名称说明

适用范围：方法

例：* @param str

the String用来存放输出信息。

@return 输出参数说明

适用范围：方法

例： *

@return true执行成功;

* false执行失败.

@since

JDK版本

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

适用范围：文件、类

例： * @since

JDK1.6

@version 版本号

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

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

例： * @version 1.0

@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

package.Class

@see

package.Class#field

@see

package.Class#Constructor(Type, Type...)

@see

package.Class#Constructor(Type id, Type id)

@see package.Class#method(Type,

Type,...)

@see package.Class#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 1.1,

replaced by

* {@link

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

追问：

谢谢您，非常详细，可是对函数的说明写在哪个tag下，比如说这个函数是干嘛的

java注释@para_Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等...相关推荐

Java8(jdk1.8)中文档注释处理工具javadoc的环境参量配置及使用方法
Java8(jdk1.8)中文档注释处理工具javadoc的环境参量配置及使用方法 Java语言提供了一种功能强大的注释形式:文档注释.如果编写Java源代码时添加了合适的文档注释,然后通过JDK提供 ...
java中文档注释作用_java中文档注释
1常用Java注释标签(Java comment tags) @author作者 @param输入参数的名称说明 @return输出参数说明 @since JDK版本 @version版本号 @see ...
Java常用的文档注释
我们程序员们在项目开发过程中,使用Java的文档注释是我们必修的一门课程.文档注释提供将程序信息嵌入程序的功能,开发者可以使用javadoc工具将信息取出. 前言:我们在开发项目过程中将文档注释使用j ...
Java注释 link_Java 文档注释
Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息, ...
Java之生成文档注释
在实际开发中,我们经常需要生成文档注释,下面简单记录一下如何生成文档注释,以下是使用EditPlus编写的java文档生成的注释. 帮助文档: 1)使用JDK,JDK中类有很多,都可以使用,了解这些类 ...
Swift 注释规范和文档注释
目录普通注释结构性或者功能提示: MARK.TODO.FIXME 编译器提示文档注释 Playground注释今天,我知道我写是什么,上帝和我知道明天,我知道这个代码什么意思 ...
为什么python注释不能中文_python注释中文
广告关闭腾讯云11.11云上盛惠 ,精选热门产品助力上云,云服务器首年88元起,买的越多返的越多,最高返5000元! 4.python代码注释最后更新于:2019-10-05 14:25:41在 p ...
java文档注释报错,java文档注释主要使用方法
一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这 ...

java注释@para_Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等...

java注释@para_Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等...相关推荐

最新文章

热门文章