java注释作者（注释 java）

今天给各位分享java注释作者的知识，其中也会对注释 java进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

微信号：cloud7591
如需了解更多，欢迎添加客服微信咨询。
复制微信号

本文目录一览：

• 1、java 文档注释是注释什么的,不是有多行注释了吗?
• 2、Java中文档注释各字段的含义是什么？例如author表示作者，para表示参数等
• 3、如何设置 Eclipse 创建类时自动添加 自动生成的 作者以及日期注释
• 4、java注释里的这些标记分别是什么意思？
• 5、java代码如何快速添加作者描述的注释最好能有详细的图解

java 文档注释是注释什么的,不是有多行注释了吗?

1、【文档注释】是写在类或者方法的上面的。

文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。

使用文档注释时，需要在开始的 /** 之后，第一行或几行是关于类、变量和方法的主要描述。

之后，可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该消陵放成一组。

2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。

3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释 的内容可以生产一个开发者文档。

扩展资料

java常用的文档注释标签

1、@author：标识一个类的作者

实例： @author description

2、@deprecated：指名一个过期的类或成员

实例： @deprecated description

3、@exception：标志一个类抛出的异常

实例：@exception exception-name explanation

4、{@inheritDoc}：从直接父类继承的注释颂禅

实例：Inherits a comment from the immediate surperclass.

5、{@link}：插入一个到另一个主题的链接

实例：{@link name text}

6、{@linkplain}：插拿樱戚入一个到另一个主题的链接，但是该链接显示纯文本字体

实例：Inserts an in-line link to another topic.

7、@param：说明一个方法的参数

实例：@param parameter-name explanation

8、@return：说明返回值类型

实例：@return explanation

9、@see：指定一个到另一个主题的链接

实例：@see anchor

10、@serial：说明一个序列化属性

实例：@serial description

参考资料：百度百科-java注释

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

常用Java注释标签（Java comment

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 创建类时自动添加 自动生成的 作者以及日期注释

使用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注释，总共有3种注释方法。

1、注释一行（在eclipse里的快捷键是：crtl+/）。快捷键按一下注释，再按一迅李毕下，取消注释。

//内容

//内容

2、注释多行、块注释（在eclipse里的快捷键是：crtl+shift+/）。快捷键按一下注释，再按一下，不能取消注释。只能人为的删除。

/*内亩芹容

内容

内容*/

3、文档注释（在eclipse里的快捷键是：/**+enter）。快捷键按一下注释。仅这注释方法可以写入javadoc文档

/** 内容

*内容

*内容

*/

4、javadoc注释标签语法的一些说明。（你可以输入@，在加alt+/（补全键））

@author  对类的说明--标明开发该类模块的作者

@version  对类的说明--标明该类模块的版本

@param    对方法的说明--方法中扰没某参数的说明

@return  对方法的说明--方法返回值的说明

@exception  对方法的说明--方法可能抛出的异常的说明

注释的一些要求。

注释内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

END

注意事项

注释内容是不被编辑的内容，只是解释说明

注释，为了更方便的阅读

每次单行注释、多行注释，要选中要注释的内容

java代码如何快速添加作者描述的注释最好能有详细的图解

Window --Preferences-Java-Editor-Templates ，

在这里new一个自己的插入注释的快捷方式名称陆银，具体设置如下：

Name处输入 remark (任意你喜欢的名称)

context处选橘裂 java 后边勾选Automatically insert复选框

Description 这里可以任意输入描述

Pattern :(自定义格式)

/**

* @author ${user}

* @date : ${date} ${time}

*/

到这里全部设置完毕，下面 OK,找个java类,找个空白处测试一下, 输入remark(前面写的那个圆悉闭Name名称),

再alt+/ 应该按一下就能看到刚才的Description的内容。

java注释作者的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于注释 java、java注释作者的信息别忘了在本站进行查找喔。