MyEclipse代码注释模板

今天下午闲着没事情做,上网也没什么好做的,想起了MyEclipse里面的代码注释模板确实有点太大众化了点,刚刚过去的那个项目光是复制注释(文件头)就让我出了几次指摘。于是乎做了这个根本我们公司的情况作的一个代码模板。

  其实刚把这个codetemplates.xml导出来的时候,我看着也挺傻眼的。XML这块我基本上除了配置过Struts的配置文件以外很少接触过,四处翻资料,弄明白了其实也就那么回事儿,CSDN上某位大大还把他的代码模板给贴了出来了,这让我省了不少理解的功夫。毕竟单纯的理论和有一个实际的东西对照着看的话,要容易理解一点吧。

  废话少说,贴下我的模板代码:


<?xml version="1.0" encoding="UTF-8"?>
<templates>
<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">
/**
* [Product]
* ${project_name}
* [Copyright]
* Copyright ? ${year} ICSS All Rights Reserved.
* [FileName]
* ${file_name}
* [History]
* Version Date Author Content
* -------- --------- ---------- ------------------------
* 1.0.0 ${date} ${user} 最初版本
*/</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">
/**
* <b>Summary: </b>
* TODO 请在此处简要描述此类所实现的功能。因为这项注释主要是为了在IDE环境中生成tip帮助,务必简明扼要
* <b>Remarks: </b>
* TODO 请在此处详细描述类的功能、调用方法、注意事项、以及与其它类的关系
*/</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">
/**
* <b>Summary: </b>
* 构造一个 ${enclosing_type}
* <b>Remarks: </b>
* 构造类 ${enclosing_type} 的构造函数 ${enclosing_type}
* ${tags}
*/</template>
<!-- GET方法注释 -->
<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">
/**
* <b>Summary: </b>
* 获取${bare_field_name}的值
* @return ${bare_field_name}
*/</template>
<!-- SET方法注释 -->
<template
autoinsert="true"
context="settercomment_context"
deleted="false"
description="Comment for setter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
name="settercomment">
/**
* <b>Summary: </b>
* 设置 ${bare_field_name} 的值
* @param ${param}
*/</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">
/**
* <b>Summary: </b>
* ${enclosing_method}(请用一句话描述这个方法的作用)
* ${tags}
*/</template>
<!-- 代理方法注释 -->
<template
autoinsert="true"
context="delegatecomment_context"
deleted="false"
description="Comment for delegate methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
name="delegatecomment">
/**
* <b>Summary: </b>
* 代理方法 ${enclosing_method}
* ${tags}
* ${see_to_target}
*/</template>
<!-- 复写方法注释 -->
<template
autoinsert="true"
context="overridecomment_context"
deleted="false"
description="Comment for overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
name="overridecomment">
/**
* <b>Summary: </b>
* 复写方法 ${enclosing_method}
* ${tags}
* ${see_to_overridden}
*/</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}:${todo}(请用一句话描述这个变量表示什么)
*/</template>
</templates>
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值