在Eclipse中怎样写Java注释

java中的注释分为实现注释和文档注释

实现注释就是那些/……../和//……的注释，是注释程序用的，文档注释是/*……./的注释，是用来生成javadoc的。设置方法如下：
1.打开Eclipse的偏好设置：



2.依次选择Java > Code Style > Code Template > Comments:



一、文件注释

文件头注释以 /开始，以/结束，其中列出类名，版本信息，日期和版权声明。
选择comments下的Files，点击Edit进行编辑：



/*
* ${file_name}
* Version 1.0.0
* Created on ${date}
* Copyright QuickCodes.net
*
*/

 

设置好了之后，你新建类的时候ec就会自动帮你生成文件注释了。

二、类、接口注释

类、接口注释/*开始，以/结束,作为类或接口的介绍信息出现在生成的javadoc中。一般写成下面这样。

 

/**
 * @author ${user}
 * @version 1.0.0
 * @since 
 * ${tags}
 * 创建时间：${date}
 * 功能描述：
 * 官方网站：www.QuickCodes.net
 * 邮箱地址：Mac.Manon@QuickCodes.net
 */

 

使用方法：
新建一个类后，在类声明的地方输入“/**”：



回车后自动生成如下注释：



在上面的例子中，@author、@version和@see是标记。标签分为块标签（block tag）和内联标签（inline tag）。块标签直接@tag来用，内联标签是{@tag}来用的。下面介绍几个常用的块标签

@author

用在类注释中，表示作者。函数注释里面可以不出现@author。

@version

用在类注释中，表示版本信息。函数注释里面可以不出现@version。

@since

用在类注释中，标明该类可以运行的JDK版本

@param标记

@param标记后跟的是方法的参数名，注意不是参数类型。

@return标记

@return后跟的是方法的返回值类型。返回为空（void）的构造函数或者函数，@return可以省略。

关于注释标签的详细信息可以看http://java.sun.com/j2se/javadoc/writingdoccomments/#tag

三、属性注释（field）

可以是实现注释也可以是文档注释，如果是文档注释，会在javadoc中出现，比如



/** 用户ID */
private Integer userID;

/** 用户名 */
private String userName;

 

四、方法注释

方法注释采用 /** … */，描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息



/**
     * 
     * @param userName
     * @param password
     * @return
     */
    public String doLogin(String userName,String password){
        return "loginsuccess";
    }

 

关于java的注释规范可以详见http://java.sun.com/j2se/javadoc/writingdoccomments/