eclipse修改默认注释模板

本文详细介绍如何在Java开发环境中设置代码注释模板,包括文件、类、字段、构造方法、普通方法、重写方法、代理方法、getter和setter方法的注释设置,提升代码可读性和维护效率。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

首先介绍几个常用的注解:

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@return 返回值

@throws 异常类及抛出条件

@deprecated 引起不推荐使用的警告

@override 重写

这个注解我们在java代码中经常可以看到。

设置注释模板的步骤:点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates,对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息,在生成java文件时便会自动生成注释,当然也可以手动插入注释。设置的界面如下:

点击Edit按钮,进入编辑页面,全部编辑完成后点击“Apply And Close”即可设置完成,并关闭设置页面。

  • 下面介绍具体的Comment如何设置:

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

     

    /**  

    * <p>Title: ${file_name}</p>  

    * <p>Description: </p>  

    * <p>Copyright: Copyright (c) 2017</p>  

    * <p>Company: www.baidudu.com</p>  

    * @author shenlan  

    * @date ${date}  

    * @version 1.0  

    */  

  • 2. 点击Types对类进行注释:

     

    /**  

    * <p>Title: ${type_name}</p>  

    * <p>Description: </p>  

    * @author shenlan  

    * @date ${date}  

    */  

     

    3. 点击Fields对字段进行注释:

     

    /** ${field}*/  

     

    4. 点击Constructors对构造方法进行注释:

     

    /**  

    * <p>Title: </p>  

    * <p>Description: </p>  

    * ${tags}  

    */  

     

    5. 点击Methods对方法进行注释:

     

    /**  

     

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

     

     * <p>Description: </p>  

     

     * ${tags}  

     

     */  

  • 6. 点击Overriding Methods对重写方法进行注释:

     

    /* (non-Javadoc)  

     

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

     

     * <p>Description: </p>  

     

     * ${tags}  

     

     * ${see_to_overridden}  

     

     */

     

    7. Delegate methods对代表方法进行注释:

     

    /**  

    * ${tags}  

    * ${see_to_target}  

    */

     

    8. Getters对get方法进行注释:

     

    /**

     

     * @return the ${bare_field_name}  

     

     */

     

    9. Setters对set方法进行注释:

     

    /**

     

     * @param ${param} the ${bare_field_name} to set  

     

     */

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值