android studio 新建函数注释模板



今天，简单讲讲如何使用



android studio 新建函数注释模板。

这个其实也很简单，

Android Studio默认函数注释为
 /**  *   */
下面方法将要改为如下格式
/**** @author zony* @time 15-11-25 下午2:41*/
步骤如下：
一、File->Setting->Editor->Live Templates
二、点击最右边+，创建一个Template Group
三、填写group名，任意填写
四、选中你刚刚创建的group，创建Live Template
五、填写Abbreviation,方便输入和记忆可输入doc,即这个注释的快捷方式，在函数体上方输入doc加回车即可
六、输入注释模板，Template text注释模板，可参考eclipse模板，我的模板如下

七、设置doc快捷键生效位置：在声明的时候生效，即你在函数名上面输入doc加回车

这里是点击下方的Change按钮弹出的对话框，当时找了好久才找到这个按钮。

八、关键一点，此步不对的话date和author不会生效
对定义的四个变量desc、user、date、time进行赋值，点击Edit variables，按照如下图设置变量

这里面的都是android studio自带的函数，大家只能选择自己需要的。

九、见成效的时刻，在函数名上输入doc然后回车即可

二，Android Studio添加函数注释模板

1，javaDoc自动生成注释

如果我们想获取到方法名，参数返回值的信息，想让这些信息全部自动生成的注释里面的话，我们可以借助插件JavaDoc实现，安装插件javaDoc 安装完之后重启studio

安装JavaDoc插件

File → Settings → Plugins → Browse repositories 然后搜索Javadoc，然后点击install并重启androidstudio就ok了。

当在函数的前面输入“/**”按回车键，就会补全整个注释

/**     * @param a     * @param b     * @return     */    public int getSum(int a,int b){        return a;    }

android studio 新建函数注释模板就讲完了。

就这么简单。