「java作者注释」Java的注释

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

本文目录一览：

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

java注释里的这些标记分别是什么意思？

方法/步骤

java注释，总共有3种注释方法。

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

//内容

//内容

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

/*内容

内容

内容*/

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

/** 内容

*内容

*内容

*/

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

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

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

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

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

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

注释的一些要求。

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

END

注意事项

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

注释，为了更方便的阅读

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

如何设置 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中文档注释各字段的含义是什么？例如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)}

*/

java中的注释可分为三种类型

Java中三种类型的注释：

单行注释：// 注释内容

多行注释：/*... 注释内容....*/

文本注释：/**.. 注释内容....*/

代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以不是为写注释而写注释。

备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释。

扩展资料：

类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等。

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

java 中的几种注释方式

我看动力节点的java基础大全301集教中的三种注释方法：

1、单行注释   //注释的内容

2、多行注释  /*......*/

3、/**......*/，这种方式和第二种方式相似。这种格式是为了便于javadoc程序自动生成文档。

下面介绍一下Javadoc的标记：

特别声明：

（1）javadoc针对public类生成注释文档

（2）javadoc只能在public、protected修饰的方法或者属性之上

（3）javadoc注释的格式化：前导*号和HTML标签

（4）javadoc注释要仅靠在类、属性、方法之前

下面主要举例说明第三种注释的应用：

（1）首先编写.java文件

（2）在命令行中执行以下dos命令：

javadoc *.java //根据相应的Java源代码及其说明语句生成HTML文档

//javadoc标记：是@开头的，对javadoc而言，特殊的标记。

（3）在当前目录下就会产生doc文件夹，里面有一系列的.html文件

附上代码：

[java] view plain copy

span style="font-size:18px;"*/

/**javadoc注释的内容

*/

public class Hello{

/**属性上的注释*/

public String name;

/**这是main方法,是程序的入口

*@param args 用户输入参数

*/

public static void main(String[] args){

System.out.println("Hello World!");

f1();

}

/** 这是第1个方法,其作用是...*/

public static void f1(){

System.out.println("f1()！");

}

}/span

[java] view plain copy

span style="font-size:18px;"import java.io.IOException;

/**javadoc注释内容

*@since 1.0

*@version 1.1

*@author Blue Jey

*br链接到另一个文档{@link Hello},就这些

*see Hello

*/

public class HelloWorld{

/**非public，protected 属性上的注释不生成*/

public String name;

/**这是main方法，是程序的入口

*@param args 用户输入的参数，是数组

*@throws IOException main方法io异常

*/

public static void main(String args[]) throws IOException{

System.out.println("hello World!");

f1();

f2(1);

}

/**这是第一个方法，其作用是....

*@deprecated 从版本1.2开始，不再建议使用此方法

*/

public static void f1(){

System.out.println("fl()!");

}

/**这是第二个方法，其作用是....

*@return 返回是否OK

*@param i 输入参数i

*@see Hello

*@throws IOException io异常

*/

public static String f2(int i)throws IOException{

System.out.println("f1()!");

return "OK";

}

} /span

注意：

如果源文件中有用到@version,@author标记，则在执行javadoc命令时，要加-version -author

javadoc -version -author -d doc *.java

（其中用-version用于提取源文件中的版本信息 -author用于提取源文件中的作者信息）

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的注释的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。