美文网首页注释程序员Android开发
Android stuido 注释设置与使用

Android stuido 注释设置与使用

作者: tigergang | 来源:发表于2016-03-24 19:17 被阅读705次

    相信越来越多的小伙伴在使用AS了,养成一个规范的代码风格也是很重要的。

    1.设置文件注释

    1.File->Setting->Editor

    我们可以在文件模板中新建一个文件模板

    上图代码:

    ```

    *  Author:  ${USER}

    *  Date:  ${DATE}

    *  FileName:  ${NAME}.java

    *  History:

    * 1.  Date:${DATE} ${TIME}

    *     Author:${USER}

    *    Modification:

    */

    #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

    #parse("File Header.java")

    public class ${NAME} {

    }

    ```

    然后新建类kind选择BaseClass就可以了。

    2.设置方法注释

    1.File->Setting->Editor->Live Templates

    2.点击+,创建一个Template Group

    3.选中你刚刚创建的group,创建Live Template

    4.填写Abbreviation,我这里填的是cmt,也即你这个注释的快捷方式,你敲cmt加回车,模板就出来了

    代码如下

    ```

    /**

    *  @function:$methodName$

    *  @description: $desc$

    *  @param:$methodParameters$

    *  @return:$methodReturnType$

    *  @history:

    *1.date:$date$ $time$

    *          author:$user$

    *          modification:

    */

    ```

    5.要设置你这个cmt快捷键在哪里生效,我的选择是在声明的时候生效,也即你在方法名上打cmt加回车就可以了

    6.注意到,我的Template text有定义了三个变量 desc,date,time,user,后面两个我要生成日期和时间,作者,所以我们要编辑这三个变量

    点击Edit variables,在弹窗里分别为date,time 和user就是设置对应的方法,date()这个方法会生成日期,time()这个方法会生成时间,user()会生成author

    7.点击Apply一切完成。现在,你只要在方法名上敲上cmt回车,就会自动生成注释模板了,时间是自动生成的

    studio也有设置注释快捷键

    选择fix dox comment然后就可以自定义了,赶紧试试吧

    相关文章

      网友评论

      本文标题:Android stuido 注释设置与使用

      本文链接:https://www.haomeiwen.com/subject/wourlttx.html