java代码标注作者 java 标注

Java中文档注释各字段的含义是什么?例如author表示作者,para表示参数等

常用Java注释标签(Java comment

成都创新互联公司成立于2013年,我们提供高端网站建设成都网站制作公司成都网站设计、网站定制、全网营销推广微信平台小程序开发、微信公众号开发、成都网站营销服务,提供专业营销思路、内容策划、视觉设计、程序开发来完成项目落地,为成都水电改造企业提供源源不断的流量和订单咨询。

tags)

@author 作者

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

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

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

例:*

@author Leo. Yao

@param 输入参数的名称 说明

适用范围:方法

例:* @param str

the String用来存放输出信息。

@return 输出参数说明

适用范围:方法

例: *

@return codetrue/code执行成功;

* codefalse/code执行失败.

@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)}

*/

在eclipse中的package explorer 中的java文件中如何显示创建时间和作者的后缀

要关联到svn库的,在每一次对java代码的修改都会记录时间和作者的。

类似以下的显示方式:

Intellij idea中新建java 自动添加作者和日期信息,是注释的,这个哪里配置的。注意:不是eclipse。

file-settings-editor-file and code templates

右边includes-file header

java.我想在程序的最后再输出一些文字和数字 比如“作者”“001",应该怎么加,加在哪?请大神明示。

System.out.println(" | ");

System.out.println("作者:XX。");

你是这个意思?

java项目,怎么找出一个作者的代码?

把项目导入到开发工具中(ECLIPSE)全局搜索你师兄的名字就知道了。

SEARCH

1,填写搜索文本

2,填写搜索文件类型

OK了

如何设置 Eclipse 创建类时自动添加 自动生成的 作者以及日期注释

使用Eclipse 编写Java代码时,自动生成的注释信息都是按照预先设置好的格式

生成的。

修改作者、日期注释格式:

打开Windows-Preferences-Java-Code Style-Code Templates,

点击右边窗口中的Comments,可以看到有很多选项,

我们便可对此注释信息模板进行编辑。

如我们希望在一个Java文件的开头设置作者信息、日期信息。

选择Types,点击Edit,将

/**

* @author ${user}

* ${tags}

*/

将${user}删除,改成你希望显示的名字

将${tags}删除,

点击Insert Variable,选择Date,这样就会自动生成日期信息。

在你需要添加注释的地方点击Sources-Ganarate Element Comment,

或者使用快捷键 Alt+Shift+J ,则 eclipse 自动在该类前面添加注释。


当前标题:java代码标注作者 java 标注
本文地址:http://azwzsj.com/article/dodsghs.html