Java注释怎么写

    java中的注释分为实现注释和文档注释，实现注释就是那些/*……..*/和//……的注释，是注释程序用的，文档注释是/**…….*/的注释，是用来生成javadoc的。eclipse(以下简称ec)中的注释规范在Window->Preference->Java -> Code Style -> Code Template中设置

•     文件注释（files）

    文件头注释以 /*开始，以*/结束，其中列出类名，版本信息，日期和版权声明。
在ec的code Template中选择comments下的Files，点击Edit进行编辑，比如做成下面这样

    /*
     * ${file_name}
     * Version 1.0.0
     * Created on ${date}
     * Copyright your company
     *
     */

    设置好了之后，你新建类的时候ec就会自动帮你生成文件注释了。
以下类型的注释在ec中设置跟这个一样，下面就不详细说明了，注释类型后的括号里表示的是在ec上要设置的类型

•      类、接口注释（types）

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

    /**
     * This class SortedTable is used to create a sorted Jtable
     * @author jnight
     * @see java.swing.JTable
     */

    例子中出现的@author和@see是标记。标签分为块标签（block tag）和内联标签（inline tag）。块标签直接@tag来用，内联标签是{@tag}来用的。下面介绍几个常用的块标签
1. @author
用在类注释中，表示作者。函数注释里面可以不出现@author。

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

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

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

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

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

•     属性注释（field）

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

/** the comments of the String field.*/
    private String strField = "";

•     方法注释

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

    /**
     * comments of your meyhod.
     * @param str comments of the String parameter.
     * @return int
     *
     */

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