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

所属分类: 软件编程 / Android 阅读数: 1500
收藏 0 赞 0 分享

本文实例讲述了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">/** * &lt;p&gt;Title: &lt;/p&gt; * &lt;p&gt;Description: &lt;/p&gt; * $
  • 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程序设计有所帮助。

    更多精彩内容其他人还在看

    Retrofit2日志拦截器的使用

    这篇文章主要介绍了Retrofit2日志拦截器的使用,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    收藏 0 赞 0 分享

    Android创建外部lib库及自定义View的图文教程

    这篇文章主要给大家介绍了关于Android创建外部lib库及自定义View的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    收藏 0 赞 0 分享

    Android分享微信小程序失败的一些事小结

    这篇文章主要给大家介绍了关于Android分享微信小程序失败一些事,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    收藏 0 赞 0 分享

    Android分享微信小程序技巧之图片优化

    这篇文章主要给大家介绍了关于Android分享微信小程序技巧之图片优化的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    收藏 0 赞 0 分享

    Android Viewpager实现无限循环轮播图

    这篇文章主要为大家详细介绍了Android Viewpager实现无限循环轮播图,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    收藏 0 赞 0 分享

    Android中的Bitmap序列化失败的解决方法

    这篇文章主要介绍了Android中的Bitmap序列化失败的解决方法,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    收藏 0 赞 0 分享

    Android自定义通用标题栏CustomTitleBar

    这篇文章主要为大家详细介绍了Android自定义通用标题栏CustomTitleBar,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    收藏 0 赞 0 分享

    Android组合控件自定义标题栏

    这篇文章主要为大家详细介绍了Android组合控件自定义标题栏,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    收藏 0 赞 0 分享

    Android自定义复合控件实现通用标题栏

    这篇文章主要为大家详细介绍了Android自定义复合控件实现通用标题栏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    收藏 0 赞 0 分享

    ExpandableListView实现简单二级列表

    这篇文章主要为大家详细介绍了ExpandableListView实现简单二级列表,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    收藏 0 赞 0 分享
    查看更多