Android Studio添加文件注释头模板?

https://blog.csdn.net/u010503822/article/details/78545095###;

设置文件头

类注释

/**
  *
  * @ProjectName:    ${PROJECT_NAME}
  * @Package:        ${PACKAGE_NAME}
  * @ClassName:      ${NAME}
  * @Description:     java类作用描述
  * @Author:         唐朝
  * @CreateDate:     ${DATE} ${TIME}
  * @UpdateUser:     更新者
  * @UpdateDate:     ${DATE} ${TIME}
  * @UpdateRemark:   更新说明
  * @Version:        1.0
 */

 2.配置方法通过短名进行生成注释 


cmt这个用于快捷生成,类似myeclipse的main回车的快速生成main方法。

 /**
 *
 * @ProjectName:    $PROJECT_NAME$
 * @Package:        $PACKAGE_NAME$
 * @ClassName:      $NAME$
 * @Description:    java类作用描述
 * @Author:         唐朝
 * @CreateDate:     $DATE$ $TIME$
 * @UpdateUser:     更新者
 * @UpdateDate:     $DATE$ $TIME$
 * @UpdateRemark:   更新内容
 * @Version:        1.0
 */
  • mcmt


mcmt的作用类似cmt,需要注意这里在java方法内部输入“mcmt”回车,出现生成的注释。

 /**
 * @method  $methodName$
 * @description 描述一下方法的作用
 * @date: $date$ $time$
 * @author: 唐朝
 * @param $param$
 * @return $return$
 */

groovyScript脚本,上面的params配置

groovyScript("def result=‘‘; def params=\"${_1}\".replaceAll(‘[\\\\[|\\\\]|\\\\s]‘, ‘‘).split(‘,‘).toList(); for(i = 0; i < params.size(); i++) {result+=‘ * @param ‘ + params[i] + ((i < params.size() - 1) ? ‘\\n\\b‘ : ‘‘)}; return result", methodParameters())


一、类注释

/**
*
* @ProjectName: ${PROJECT_NAME}
* @Package: ${PACKAGE_NAME}
* @ClassName: ${NAME}
* @Description: java类作用描述
* @Author: 唐朝
* @CreateDate: ${DATE} ${TIME}
* @UpdateUser: 更新者
* @UpdateDate: ${DATE} ${TIME}
* @UpdateRemark: 更新说明
* @Version: 1.0
*/

二、方法注释

/**
* @method $methodName$
* @description 描述一下方法的作用
* @date: $date$ $time$
* @author: 唐朝
* @param $param$
* @return $return$
*/

+++++++++++

Eclipse Java注释模板设置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦

文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/

类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/

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

构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

方法(Constructor & Methods)标签:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/

覆盖方法(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}
*/

原文地址:https://www.cnblogs.com/bluestorm/p/8747860.html

时间: 2024-08-07 07:25:09

Android Studio添加文件注释头模板?的相关文章

Android开发之深入理解Android Studio构建文件build.gradle配置

摘要: 每周一次,深入学习Android教程,TeachCourse今天带来的一篇关于Android Studio构建文件build.gradle的相关配置,重点学习几个方面的内容:1.applicationId和package属性值的关系,2.怎么配置安全的自定义签名,3.两种构建类型的区别,4.为什么要定制产品的偏好配置?,5.怎么才能加快DEX文件的生成速度,6.为什么要将一个apk拆分成多个?,7.关于引入依赖包你不知道的秘密.通过这篇文章的学习,你会对build.gradle文件有一个

Eclipse / android studio 添加第三方jar包 步骤

eclipse 将第三方包放到libs文件夹后并没有引用. 基本步骤分为3步,具体介绍如下: 打开自己的Eclipse,在自己的Android工程上名上右键->Build Path ->Configure Build Path 2. 在Libraries选项卡中,选择右侧的Add External JARs,然后选择要导入的第三方的jar包即可! 3 在Order and Export选项卡中,点击右侧的Up按钮,将刚才引入的jar包放到最上方的位置,前边的勾记得要勾上! (关于放到首位,是自

Android Studio添加插件(Genymotion)

官方模拟器的龟速已让我们无力吐槽,幸好有genymotion这款逆天的Android虚拟机,它有着快速的开启速度,良好的交互界面.是Android开发必备的良品,甚至有些玩家已经用genymotion在电脑上玩Android游戏.今天就要和大家分享如何在Android Studio添加插件(Genymotion). 首先你要去genymotion 官网  https://www.genymotion.com,下载这两个文件 如图 然后 双击第一个文件安装,一直next即可(中间一些安装路径可以自

Android Studio添加Parcelable序列化小工具(快速提高开发效率)

Android Studio添加Parcelable序列化小工具(快速提高开发效率) Android Studio是google专门为开发Android提供的开发工具,在它内部可以直接的添加一些非常好用的开发小工具,这里就讲解怎样添加这些小工具,并且向大家推荐一个非常有用的对象传递时,必须要把对象序列化的接口Parcelable小工具; 这里先介绍下 Android中实现序列化的两个选择:一是实现Serializable接口(是JavaSE本身就支持的),一是实现Parcelable接口(是An

Android studio 添加依赖

以前添加依赖总是到github上下载源码,再添加源码到module的依赖当中,其实在studio中,应该使用maven库. 比如在github上看到了sliding-menu这个项目,就应该到maven网站上找对应的库,之后把地址写入build.gradle中,比如以下就是sliding-menu的库, compile 'com.github.itsmechlark.android-sliding-menu:android-sliding-menu:1.0.1' 这样做的好处就是不必再 Andr

为什么 Android Studio 工程文件夹占用空间这么大?我们来给它减减肥

偶然中发现Android Studio的工程文件夹比ADT Bundle的大很多.用Android Studio新建一个空工程,工程文件夹大小为30M,运行一次后大小为40M.同样用ADT Bundle新建一个空工程,工程文件夹大小为1.5M,运行一次后大小为3.8M.天哪!Android Studio的工程比ADT Bundle的工程至少大了10倍啊! 这是为什么呢?带着疑惑打开Android Studio工程文件夹,在<工程根目录>\build\generated文件夹中发现有个叫mock

批量替换程序的文件注释头

Install: Just unpack the files into your home directory. It will create a directory ~/rh containing all files. Now edit the file ~/rf/header.template to fit your needs. That's it. Usage: ~/rh/replace_header.sh <file> This replaces only the header of

【Android Studio探索之路系列】之六:Android Studio添加依赖

作者:郭孝星 微博:郭孝星的新浪微博 邮箱:[email protected] 博客:http://blog.csdn.net/allenwells github:https://github.com/AllenWell 本文主要讲解如何在Android Studio中添加JAR包.Module和SO库. 一 JAR包的依赖配置 首先使用快捷键Ctrl+Alt+Shift+S打开当前项目的配置,如下图所示: 1.1 直接搜索法 点击 +->Library dependency,如下图所示搜索选择

Android Studio添加包的BUG处理

在开发中,经常遇到Android studio不clean的话就不更新代码. 今天想添加一个包,却怎么也添加不进去,我的版本如下: 添加包怎么也添加不上去 不知道是不是此版本的BUG,我用的是目前最新版的,请知情人士告知. 解决办法:需要去SDK的路径中找到相关的包,然后手动引入,如下图: 找到该包后,按F2,然后复制名称,去Build.gradle中引入,如下: 引入后clean一下,然后就加进去了,删除也是在这里删除. 我认为这个方法虽然可行,但是真心麻烦,感觉应该是目前新版本的BUG,自从