eclipse之设置作者信息

一时失言乱红尘 2021-09-28 08:44 447阅读 0赞

下面介绍一下常用的注释配置信息：

一、首先介绍一下常用的注解

@author 作者名
    @date 日期
    @version 版本标识
    @parameter 参数及其意义
    @return 返回值
    @throws 异常类及抛出条件
    @deprecated 引起不推荐使用的警告
    @override 重写

二、设置注释模板的步骤  
点击菜单栏上的Window-》Preference-》Java-》Code Style-》Code Template，对右侧的Commnets选项具体的注释信息进行编辑即可。可勾选上自动添加注释信息，在生成java文件时便会自动生成注释，当然也可以手动插入注释。  
设置界面如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDAzMDYz_size_16_color_FFFFFF_t_70]

1）点击Comments下的Files可对整个Java文件进行注释：包括公司名称，版权所属，作者信息，日期等。

/** 
 
 * Title: ${file_name} 
 
 * Description: 
 
 * @author wxy
 
 * @date ${date} 
 
 * @version 1.0 
 
 */

2)点击Types对类进行注释：

/** 
 
 * Title: ${type_name} 
 
 * Description: 
 
 * @author wxy
 
 * @date ${date} 
 
 */

3)点击Constructors对构造方法进行注释：

/** 
 
 * Title: 
 
 * Description: 
 
 * ${tags} 
 
 */

4)点击Methods对方法进行注释：

/** 
 
 * Title: ${enclosing_method} 
 
 * Description: 
 
 * ${tags} 
 
 */

三、快捷键生成注释  
1）在设置默默时如果勾选了自动注释信息，则在创建java文件时会自动生成文档和类的注释信息，若没有勾选，按Shift+Alt+J快捷键也可生成。

2）在对类中的方法进行注释，在方法上输入/\*\*后点击回车，即可生成方法注释；或将光标放在方法名上，按住Shift+Alt+J快捷键也可；或者方法上右击source》generate》Element Comment也可生成注释。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNDAzMDYz_size_16_color_FFFFFF_t_70]: /images/20210923/2aeeec9d57e244deb33cb58ae1861173.png