【转载】myeclipse自动生成注释

在使用Eclipse编写Java代码时，自动生成的注释信息都是按照预先设置好的格式生成的，例如其中author 的属性值。

我们可以在Eclipse中进行设置自己希望显示的信息。

      现在看看如何修改我们的用户名即作者信息：点击Windows->Preferences->Java->Code Style->Code Templates,

 

           然后我们就可以选择右边窗口中的Comments，对应具体的comments选项，我们便可以对具体的注释信息进行编辑设置。

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

            选择Types，点击Edit，将

/**
  * @author ${user}
 * ${tags}
 */  

将${user}删除，改成hanyankai，这样作者信息就变成hanyankai；点击Insert Variable，选择Date，这样就会自动生成日期信息。

      设置完以后我们测试一下，自动生成的注释信息为：

/**
 * @author hanyankai

 * 2009-11-27
 */

     同样的步骤，我们也可以对其他例如构造函数等等注释信息进行编辑设置。

    使用时鼠标放置在需要添加注释的方法内部的任意位置。点击菜单栏中【源代码】下的【添加Javadoc注释】，或者使用快捷键Alt Shift J，则eclipse自动在该方法前面添加注释。

 

注释的规范如下：

文件注释标签：

/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2007</p>
* <p>Company: zkyr</p>
* @author Uu
* @date ${date}
* @version 1.0
*/

 

 

类型注释标签（类的注释）：

/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: zkyr</p> 
* @author   Uu
* @date       ${date}
*/

 

 

字段注释标签：

/** ${field}*/

 

 

构造函数标签：

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

 

方法标签：

/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/

 

覆盖方法标签：

/* （非 Javadoc）
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/

 

 

代表方法标签：

/**
* ${tags}
* ${see_to_target}
*/

 

getter方法标签：

/**
* @return ${bare_field_name}
*/

 

setter方法标签：

/**
* @param ${param} 要设置的 ${bare_field_name}
*/

 来自：http://blog.csdn.net/aaronuu/article/details/7065928