zoukankan      html  css  js  c++  java
  • Eclipse注释模板

     

    Eclipse作为JavaIDE(Integrated Development Environment,集成开发环境),可以通过设置自动添加Javadoc注释信息,如@author 作者名、@version 版本标识、@date 日期等,在创建类或新增方法时会自动添加注释信息。

    @author 作者名

    @date 日期

    @version 版本标识

    @parameter 参数及其意义

    @return 返回值

    @throws 异常类及抛出条件

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

    @override 重写

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

    编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template

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

    复制代码
    /**  
     * All rights Reserved, Designed By www.tydic.com
     * @Title:  ${file_name}   
     * @Package ${package_name}   
     * @Description:    描述   
     * @author: Durant2035     
     * @date:   ${date} ${time}   
     * @version V1.0 
     * @Copyright: 
     */  
    复制代码

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

    复制代码
    /**   
     * @ClassName:  ${type_name}   
     * @Description:${todo}(描述这个类的作用)   
     * @author: Durant2035
     * @date:   ${date} ${time}    
     * ${tags}  
     * @Copyright:  
     */  
    复制代码

    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>  
     */  

     在设置模板时如果勾选了自动添加注释信息,则在创建Java文件时会自动生成文档和类的注释信息,若没有勾选,按Shift+Alt+J快捷键也可生成。

     在对类中的方法进行注释是:在方法上方输入/** 后点击回车,即可生成方法注释;或将光标放在方法名上,按住Shift+Alt+J快捷键也可;或在方法上右击,source》Generate Element Comment也可生成注释。

    注释模板设置完一定要点击Appy保存

  • 相关阅读:
    1128项目跟进
    冲刺一 (day 3)
    1118 冲刺1-需求文档(初稿)
    1117 新冲刺 day1
    0622 总结与回顾
    0621 第三次冲刺
    0617 主存空间的分配和回收
    学习进度条
    软件工程学期总结
    学术诚信与职业道德
  • 原文地址:https://www.cnblogs.com/kelelipeng/p/11549945.html
Copyright © 2011-2022 走看看