java 注释末班快捷键_java快捷键一键注释 - CSDN
  • Java注释和注释模板

    2016-12-06 03:42:57
    来自 http://www.cnblogs.com/fsjohnhuang/p/3988883.html Java魔法堂:注释注释模板 一、注释   1. 注释类型  [a]. 单行注释 // 单行注释 String type = "单行注释";  [b]. 多行注释 /

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

    Java魔法堂:注释和注释模板

    一、注释                                  

      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节点(方法注释标签)

    复制代码
    /** 
    * @Title: ${enclosing_method} 
    * @Description: ${todo}(这里用一句话描述这个方法的作用) 
    * @param ${tags}  参数说明 
    * @return ${return_type}    返回类型 
    * @throws 
    */
    复制代码

         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
    展开全文
  • STS 或 Eclipse 注释模板

    2019-04-23 16:53:59
    1.配置路径 Java模板入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。 现就每一个元素逐一介绍: 文件(Files)注释标签: /** * @Title $...

    1.配置路径 Java模板入口:

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

    文件(Files)注释标签:
    /**   
     * @Title  ${file_name} 
     * @Package  ${package_name} 
     * @Description  ${todo}
     * @author  例如(shiziqiu)   
     * @date  ${date} ${time} 
     * @version  1.0   
     */
    
    类型(Types)注释标签(类的注释):
    /** 
     * @ClassName  ${type_name} 
     * @Description ${todo}
     * @author 作者署名
     * @date  ${date} ${time} 
     * 
     * ${tags} 
     */
    
    字段(Fields)注释标签:
    /** 
     * @Fields ${field}  ${todo}
     */ 
    
    构造函数标签:
    /** 
     * Title  
     * Description  
     * ${tags} 
     */
    
    方法(Constructor & Methods)标签(构造器以及方法注释):
    /** 
     * @Title  ${enclosing_method} 
     * @Description  ${todo}
     * ${tags} ${return_type} 
     */
    
    覆盖方法(Overriding Methods)标签:
    /* (非 Javadoc) 
     * <p>Title  ${enclosing_method}</p> 
     * <p>Description   </p> 
     * ${tags} 
     * ${see_to_overridden} 
     */
    
    代表方法(Delegate Methods)标签:
    /** 
     * ${tags} 
     * ${see_to_target} 
     */ 
    
    getter方法标签:
    /** 
     * @return ${bare_field_name} 
     */
    
    setter方法标签:
    /** 
     * @param ${param} 要设置的 ${bare_field_name} 
     */
    
    展开全文
  • IntelliJ IDEA中手动生成javadoc注释 在需要注释的地方输入 /** 如下图: 太简单了。。。我也就瞎几把写一下而已 ...

    IntelliJ IDEA中手动生成javadoc注释

    在需要注释的地方输入

    /**

    如下图:

    这里写图片描述

    太简单了。。。我也就瞎几把写一下而已

    展开全文
  • 一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)1、File--&gt;settings--&gt;Editor--&gt;File and Code Templates--&gt;Files我们选择Class文件(当然你要设置接口的还也...

    一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)

    1、File-->settings-->Editor-->File and Code Templates-->Files

    我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)

    1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

    2)TODO:代办事项的标记,一般生成类或方法都需要添加描述

    3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

    4)1.0:设置版本号,一般新创建的类都是1.0版本,可以直接先写上1.0,后期有需要可改


    附上源码:

    /**
        *@ClassName ${NAME}
        *@Description TODO
        *@Author ${USER}
        *@Date ${DATE} ${TIME}
        *@Version 1.0
        */

    2、效果图展示


    二、设置方法注释模板

    使用Eclipse时我们生成注释的习惯是/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

    1、File-->Settings-->Editor-->Live Templates

    (1)新建组:命名为userDefine

    2)新建模板:命名为*

    因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为

    /*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、

    获取方法返回值的methodReturnType()

    3)设置生成注释的快捷键

    4)设置模板:模板内容如下

    注意第一行,只有一个*而不是/*

    在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名

    *

     * @Author chengpunan

     * @Description //TODO $end$ * @Date $time$ $date$

     * @Param $param$

     * @return $return$

     **/

    如果使用/*生成的模板注释将会是如下效果:所以我们要去掉最前面的/*

     效果图:


    5)设置参数的获取方式

    选择右侧的Edit variables按钮

     

    选择每个参数对应的获取方法(在下拉选择框中选择,如上图设置即可)

    (6)设置模板的应用场景

    点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可

    (如果曾经修改过,则显示为change而不是define)


    7)创建方法,在方法上面写:/*+模板名+Enter-->/**+Enter即可

                >>快去试试吧!!


    展开全文
  • IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。 这里设置的注释模板采用Eclipse的格式,...
  • Android Studio 注释模板

    2018-11-12 10:43:25
    Android Studio 注释模板
  • IDEA配置注释模板

    2018-09-13 10:35:56
    IDEA配置注释模板 一、配置类注释模板 1、File → setting... → Editor → Live Templates,如下图所示: 2、点击右侧 + 号,选择创建模板组,并输入模板的名称,具体如下图所示: 3、选择刚刚新建的...
  •   在使用Idea的时候,它的注释模板很简单,不够详细;所有大多数开发者都想设置一个比较详细的注释模板,我现在把我了解的创建类注释模板和方法注释模板的操作记录下来,分享给大家 我们需要定义的注释模板如下: ...
  • IDEA注释模板

    2019-05-11 17:23:57
    一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释) 1、File–>settings–>Editor–>File and Code Templates–>Files 2、 /** *@ClassName ${NAME} *@Deacription TODO *@...
  • 万能注释模板

    2018-08-01 15:53:15
    代码的注释是我们平时必须面对的问题,今天我们就来看看如何自定义属于自己的注释模板。提高我们的开发效率。 2、打开相应位置 File–&gt;Setting–&gt;Editor–&gt;LiveTemplate: 2、新建一个...
  • Eclipse 添加注释模板

    2019-04-16 09:29:45
    Perferences–>Java–>Code Style->...可以自己选择添加何种形式的注释: Files则是文件注释、 Types 类型注释、Fields字段注释、Methods 方法注释、 Constructors 构造函数注释等… 点击需要...
  • 1、可通过如下三种方法自动添加注释: 输入“/**”并回车。 用快捷键 Alt+Shift+J(先选中某个方法、类名或变量名)。 在右键菜单中选择“Source &gt; Generate ElementComment”。 2、新建文件或类的时候,...
  • 2.在other这个tab页找到activity.java ,把其中的内容复制下来 3.在templates这个tab点击左上角的加号,添加一个名称为Activity的模板, 把刚才的内容黏贴进来 4.在 Includes这个tab页,选中file header进行编辑
  • 在VisualStudio中,如果是C#语言,在类或方法上部输入 /// ;如果是VB.NET,输入 ''' 。... 在MyEclipse中,在需要被注释的代码区(如类或方法)上部输入 /** ,回车,就可以为类或方法生成已经设置好的注释模板。
  • 背景简介丰富的注释和良好的代码规范,对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的,往往会形成自己的一套编码规范。但是再实施过程中,如果全靠手动完成,不仅效率低下,...
  • 1、设置类注释模板 这样在定义类时,都要多输入类的描述。不想的话,可以删去 ${description} 2、方法注释模板 先新建模板组,名字自己起。 然后选中自己的模板组,在模板组下新建模板 如下图给...
  • idea注释模板 类模板

    2020-01-20 10:53:57
    一、修改java类创建的模板 内容: /** *@ClassName ${NAME} *@Description TODO *@Author ${USER} *@Date ${DATE} ${TIME} *@Version 1.0 */ 二、修改注释中的user内容 以下两个文件最后添加 -Duser....
  • IntelliJ IDEA 自定义方法注解模板(转载自 昌昌93) 最近没啥事开始正式用Eclipse 转入 idea工具阵营,毕竟有70%的开发者在使用idea开发,所以它的魅力可想而知。刚上手大概有一天,就知道它为啥取名为 intelli...
  • 一:生成类注释 1、File--&gt;settings--&gt;Editor--&gt;File and Code Templates--&gt;Files--&gt;Class 蓝色框里面的内容就是我们需要设置的注释模版,填好模版,单OK,完成。 注释模版...
1 2
收藏数 31
精华内容 12
关键字:

java 注释末班快捷键