• Java魔法堂:注释和注释模板 (转)


    http://www.cnblogs.com/fsjohnhuang/p/3988883.html

    一、注释                                  

      1. 注释类型

         [a]. 单行注释

    // 单行注释
    String type = "单行注释";

         [b]. 多行注释

    /* 
     * 多行注释
     */
    String type = "多行注释";

         [c]. 文档注释

    /**
     * 文档注释
     */
    public class Dummy{}

      2. 快捷键

         [a]. 添加/取消单行注释: Ctrl+/ 

         [b]. 添加类的文档注释: Ctrl+Shift+j 

    二、注释模板                                

      作用:定义文件、类和方法等默认的注释格式,减少手工输入的工作量。

      1. 设置注释模板的入口:点击 Window->Preference->Java->Code Style->Code Template ,然后展开 Comments节点 。

      2. Comments节点 下的元素介绍:

         File节点(文件注释标签)

    复制代码
    /**   
    * @Title: ${file_name} 
    * @Package ${package_name} 
    * @Description: ${todo}(用一句话描述该文件做什么) 
    * @author fsjohnhuang
    * @date ${date} ${time} 
    * @version V1.0   
    */
    复制代码

         Types节点(类注释标签)

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

          Fields节点(字段注释标签)

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

         Constructor节点(构造函数注释标签)

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

         Method节点(方法注释标签)

    按 Ctrl+C 复制代码
    按 Ctrl+C 复制代码

         Overriding Methods节点(覆盖方法注释标签)

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

        Delegate Methods节点(代理方法注释标签)

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

        getter节点(getter方法注释标签)

    /** 
    * @return ${bare_field_name} 
    */

        setter节点(setter方法注释标签)

    /** 
    * @param ${param} 要设置的 ${bare_field_name} 
    */

      3. 导入、导出注释模板

        在 Window->Preference->Java->Code Style->Code Template 下可导入导出注释模板。

     尊重原创,转载请注明来自:http://www.cnblogs.com/fsjohnhuang/p/3988883.html  ^_^肥仔John

  • 相关阅读:
    EOF ---shell编程
    Linux错误代码含义
    linux连接sybase数据库-isql
    CH7-WEB开发(集成在一起)
    [转]ASP.NET MVC 入门10、Action Filter 与 内置的Filter实现(实例-防盗链)
    [转]ASP.NET MVC 入门9、Action Filter 与 内置的Filter实现(介绍)
    [转]ASP.NET MVC 入门8、ModelState与数据验证
    [转]ASP.NET MVC 入门7、Hellper与数据的提交与绑定
    [转]ASP.NET MVC 入门6、TempData
    [转]ASP.NET MVC 入门5、View与ViewData
  • 原文地址:https://www.cnblogs.com/bnuvincent/p/5120450.html
Copyright © 2020-2023  润新知