• eclipse中自定义注释模板


    eclipse中自定义注释模板

    编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

    1.文件(Files)注释标签:

    复制代码

    /**  
     * All rights Reserved, Designed By www.tydic.com
     * @Title:  ${file_name}   
     * @Package ${package_name}   
     * @Description:    ${todo}(用一句话描述该文件做什么)   
     * @author: XXX     
     * @date:   ${date} ${time}   
     * @version V1.0 
     * @Copyright: ${year} www.tydic.com Inc. All rights reserved. 
     * 注意:本内容仅限于XXXX信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目
     */  

    复制代码

    2.类型(Types)注释标签(类的注释):

    复制代码

    /**   
     * @ClassName:  ${type_name}   
     * @Description:${todo}(这里用一句话描述这个类的作用)   
     * @author: XXX 
     * @date:   ${date} ${time}   
     *   
     * ${tags}  
     * @Copyright: ${year} www.tydic.com Inc. All rights reserved. 
     * 注意:本内容仅限于XXX信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目 
     */  

    复制代码

    3.字段(Fields)注释标签:

    /**   
     * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)   
     */   

    4.构造函数标签:

    复制代码

    /**   
     * @Title:  ${enclosing_type}   
     * @Description:    ${todo}(这里用一句话描述这个方法的作用)   
     * @param:  ${tags}  
     * @throws   
     */  

    复制代码

    5.方法(Methods)标签:

    复制代码

    /**   
     * @Title: ${enclosing_method}   
     * @Description: ${todo}(这里用一句话描述这个方法的作用)   
     * @param: ${tags}      
     * @return: ${return_type}      
     * @throws   
     */  

    复制代码

    6.覆盖方法(Overriding Methods)标签:

    复制代码

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

    复制代码

    7.代表方法(Delegate Methods)标签:

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

    8.getter方法标签:

    /**  
     * @Title:  ${enclosing_method} <BR>  
     * @Description: please write your description <BR>  
     * @return: ${field_type} <BR>  
     */  

    9.setter方法标签:

    /**  
     * @Title:  ${enclosing_method} <BR>  
     * @Description: please write your description <BR>  
     * @return: ${field_type} <BR>  
     */  
  • 相关阅读:
    List of the best open source software applications
    Owin对Asp.net Web的扩展
    NSwag给api加上说明
    'workspace' in VS Code
    unable to find valid certification path to requested target
    JMeter的下载以及安装使用
    exception disappear when forgot to await an async method
    Filter execute order in asp.net web api
    记录web api的request以及response(即写log)
    asp.net web api的源码
  • 原文地址:https://www.cnblogs.com/guanghuiqq/p/11422151.html
走看看 - 开发者的网上家园