Eclipse中设置作者、日期、方法注释等信息

11 篇文章 0 订阅

1、如何修改我们的用户名即作者信息:

点击Windows->Preferences->Java->Code Style->Code Templates;

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

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

    选择Types,点击Edit,将

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

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

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

  /**
   * @author Alan

   * 2009-11-27
   */

3、构造函数等等注释信息的编辑设置。

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

 

  注释的规范如下:

  文件注释标签:

  /**
  * <p>Title: ${file_name}</p>
  * <p>Description: </p>
  * <p>Copyright: Copyright (c) 2013</p>
  * <p>Company: LTGames</p>
  * @author Alan
  * @date ${date}
  * @version 1.0
  */

  类型注释标签(类的注释):

  /**
  * <p>Title: ${type_name}</p>
  * <p>Description: </p>
  * <p>Company: LTGames</p> 
  * @author Alan
  * @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}
  */



  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值