android编程实现的自定义注释模板实例

本文实例讲述了android编程实现的自定义注释模板。分享给大家供大家参考,具体如下:

作为一名程序员 不仅要有一个写代码的能力,养成一个良好的编写习惯也是很重要的。今天给大家详细介绍一下如何创建注释模板,给每个类和方法都自己手动去注释信息也可以,只是这样比较繁琐。为何我们不手动去创建一个注释模板呢?

第一: 首先我们需要编写一个模板的xml文件(codetemplates.xml)

第二、我们现在就给xml文件编写主要注释的内容信息,我就直接把自己用的xml信息直接贴出来

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/**
 * @描述:
 * @方法名: ${enclosing_method}
 * $android 自定义 模板
 * @创建人:${user}
 * @创建时间:${date}${time}
 * @修改人:${user}
 * @修改时间:${date}${time}
 * @修改备注:
 * @throws
*/</template><template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
 * @描述:
 * @方法名: ${enclosing_method}
 * $android 自定义 模板
 * @返回类型 ${return_type}
 * @创建人 ${user}
 * @创建时间 ${date}${time}
 * @修改人 ${user}
 * @修改时间 ${date}${time}
 * @修改备注
 * @since
 * @throws
*/</template><template autoinsert="false" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
* <p>Title: </p>
* <p>Description: </p>
* $android 自定义 模板
*/</template><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
* @param ${param} ${bare_field_name}
*/</template><template autoinsert="false" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
* $android 自定义 模板
* ${see_to_target}
*/</template><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
* @return ${bare_field_name}
*/</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
 * @类描述:
 * @项目名称:${project_name}
 * @包名: ${package_name}
 * @类名称:${type_name}
 * @创建人:${user}
 * @创建时间:${date}${time}
 * @修改人:${user}
 * @修改时间:${date}${time}
 * @修改备注:
 * @version v1.0
 * @see [nothing]
 * @bug [nothing]
 * @Copyright go3c
 * @mail *@qq.com
*/</template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
* @标题: ${file_name}
* @包名: ${package_name}
* @功能描述:${todo}
* @作者: ${user}
* @创建时间: ${date} ${time}
* @version v1.0
*/</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
 * @字段:${field}
 * @功能描述:
 * @创建人:${user}
 * @创建时间:${date}${time}
*/</template></templates>

三、我们如何在eclipse中使用这个编写好的xml文件呢?  现在我就给大家解析一下吧!

Window --> Preferences --> Java --> Code Style --> Code Templates --> Comments --> Import --> 选择             codetemplates.xml --> OK     添加后可以自己修改邮箱地址。创建人名称可以在eclipse目录下的eclipse.ini 中增加一行 -Duser.name="whateveryouwant"。

四、我们在eclipse中如何快速使用我们写好的注释模块信息呢?

添加注释时在类名上输入/**然后回车就会自动生成如下格式注释:

/**
*
* @类描述:
* @项目名称:
* @包名:
* @类名称:AppDao
* @创建人:
* @创建时间:2014-4-30上午10:32:30
* @修改人:
* @修改时间:2014-4-30上午10:32:30
* @修改备注:
* @version v1.0
* @see [nothing]
* @bug [nothing]
* @Copyright
* @mail */

在方法名上输入/**然后回车就会自动生成如下格式注释:

/**
*
* @描述:
* @方法名: UpdatePlayerHistory
* @param db
* @param item
* @return
* @返回类型 int
* @创建人
* @创建时间 2014-4-30上午10:22:36
* @修改人
* @修改时间 2014-4-30上午10:22:36
* @修改备注
* @since
* @throws
*/

描述内容需要自己手动填写。

希望本文所述对大家Android程序设计有所帮助。

(0)

相关推荐

  • Android自定义ActionBar实例

    本文实例讲述了Android自定义ActionBar的实现方法.分享给大家供大家参考.具体实现方法如下: Android 3.0及以上已经有了ActionBar的API,可以通过引入support package在3.0以下的平台引用这些API,但这儿呢,完全自定义一个ActionBar,不用引入额外jar包,参照的是开源的UI组件GreeenDroid,项目主页:https://github.com/cyrilmottier/GreenDroid .提取出关于ActionBar的相关文件,你可

  • 使用Android自定义控件实现滑动解锁九宫格

    本文概述:  滑动解锁九宫格的分析: 1.需要自定义控件: 2.需要重写事件onTouchEvent(); 3.需要给九个点设置序号和坐标,这里用Map类就行: 4.需要判断是否到滑到过九点之一,并存储滑到过的点的序号,而且需要一个方法可以返回它们,这里用List类就行: 滑动解锁当前还是比较流行的,今天写了个简单的滑动解锁九宫格的例程,分享出来让初学者看看. 我的是这样的: Demo 首先,自定义一个View /** * 九宫格 */ public class NineGridView ext

  • Android Eclipse 注释模板的使用(图文说明)

    1.设置的入口,我我们可以在下图所示的地方个性化我们自己的代码风格 2.文件(Files)注释标签 复制代码 代码如下: /*  * @Title:  ${file_name}  * @Copyright:  XXX Co., Ltd. Copyright YYYY-YYYY,  All rights reserved  * @Description:  ${todo}<请描述此文件是做什么的>  * @author:  MeiYi  * @data:  ${date} ${time}  *

  • Android实现自定义日历

    自定义日历控件,支持旧历.节气.日期标注.点击操作 (参考网络上的日历控件改写) 注:将下面的四张资源图片拷贝到所建包的下一个image目录中,如Calendar.java 所在包为 cc.util.android.view,则需要再创建一个包cc.util.android.view.image 然后将图片拷贝进去 /****************从此出开始将代码拷贝到一个文件中*******************/ package cc.util.android.view; import

  • android自定义组件实现方法

    本文实例讲述了android自定义组件实现方法.分享给大家供大家参考.具体如下: atts.xml: <?xml version="1.0" encoding="utf-8"?> <resources> <declare-styleable name="TopBar"> <attr name="titleText" format="string"/> <

  • Android中自定义Checkbox组件实例

    在Android中,Checkbox是一个很重要的UI组件,而且在Android中,它展现的形式越来越好看,这就说明有些系统,比如4.0以下,checkbox还是比较不好看,或者跟软件的风格不协调,就需要我们自定义这个组件. 自定义这个组件很简单,简单的增加修改xml文件即可. 准备工作 准备好两张图片,一个是选中的图片,另一个是未选中的图片.本文以checked.png和unchecked.png为例. 设置选择框 在drawable下新建文件custom_checkbox.xml 复制代码

  • Android中自定义标题栏样式的两种方法

    原装的Android标题栏配色比较单调,就是黑色的一坨,现在假设你的软件需要独自添加标题栏,这样不仅美观而且可以将进度条等加进去,如何实现: 方法一.在你的那张Activity中onCreate方法中加上下面代码: requestWindowFeature(Window.FEATURE_CUSTOM_TITLE); setContentView(R.layout.main); //软件activity的布局 getWindow().setFeatureInt(Window.FEATURE_CUS

  • Android权限控制之自定义权限

    天哪,这篇文章终于说道如何自定义权限了,左盼右盼,其实这个自定义权限相当easy.为了方便叙述,我这边会用到两个app作为例子示范. Permission App: used to define a new permission 这个作为定义权限的App,我称之为Permission App. Client App: used to access the specified activity of Permission App 这个作为访问上述自定义权限的App,我称之为Client App 先

  • Android Studio注释模板介绍

    大家啊从Eclipse转到Android Studio很不习惯吧,感觉还是用Eclipse的方法注释模板比较方便,敲/**加回车,模板就加载出来了,而Android Studio却不能自定义,现在用live templates替代,具体方法通过图片和文字的方式展示如下: 步骤 1.File->Setting->Editor->Live Templates 2.点击+,创建一个Template Group 3.填个你要的group名,我的叫custom 4.选中你刚刚创建的group,创建

  • Android中自定义进度条详解

    Android原生控件只有横向进度条一种,而且没法变换样式,比如原生rom的样子 很丑是吧,当伟大的产品设计要求更换前背景,甚至纵向,甚至圆弧状的,咋办,比如: ok,我们开始吧: 一)变换前背景 先来看看progressbar的属性: 复制代码 代码如下: <ProgressBar             android:id="@+id/progressBar"             style="?android:attr/progressBarStyleHor

  • android开发教程之自定义属性用法详解

    最近项目中经常需要用到自定义控件,因此自定义属性也是经常要用到的,在此说明一下自定义属性的用法: 自定义属性都存在于/value/attr.xml文件中,以如下格式存在. 复制代码 代码如下: <resource> <declare-styleable name="自定义属性名称"> <attr name="属性名称" format="属性种类"/> ...... </declare-styleable&

随机推荐