在我们开发过程中经常需要写一些注释,如果一个项目中能保持统一的注释风格会让人觉得代码很清晰整洁,那么如何才能让myeclipse保持统一种注释风格呢,下边是我们项目中用的注释模版,希望可以帮到有此需要的同学。(附件:模版xml文件)
1、将注释模版修改为你需要的模版,保存配置好的xml文件。
<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for vars" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/** * */</template><template autoinsert="true" context="filecomment_context" deleted="false" description="Comment for created JavaScript files" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.filecomment" name="filecomment">/** * */</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** * @return the ${bare_field_name} */</template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.settercomment" name="settercomment">/** * @param ${param} the ${bare_field_name} to set */</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">/** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * ${tags} */ </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">/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author 张三丰 * @date ${date} ${time} * @version V1.0 */ </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">/** * ${see_to_target} */</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** * @return the ${bare_field_name} */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="Comment for non-overriding function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** * ${tags} */</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** * ${tags} */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate functions" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/** * ${tags} * ${see_to_target} */</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> * ${tags} */ </template><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">/** * ${see_to_overridden} */ </template><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">/** * @param ${param} the ${bare_field_name} to set */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="Comment for overriding functions" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-JSDoc) * ${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">/** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */ </template><template autoinsert="true" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.typecomment" name="typecomment">/** * @author ${user} * * ${tags} */</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"> /** * 版权所有:${year}-武当派 * 项目名称:${project_name} * * 类描述: * 类名称:${package_name}.${type_name} * 创建人:张三丰 * 创建时间:${date} ${time} * 修改人: * 修改时间:${date} ${time} * 修改备注: * @version V1.0 */ </template></templates>
2、下图介绍为myeclipse添加统一注释模版的步骤:将修改好的xml配置文件点击Important按钮导入myeclipse,完成后可以新建一个类试试看好使不好使。
3、如果注释中有写地方你不满意需要修改一下,选择comments下的数据项 ,点击Edit进行编辑。
4、编辑好注释模版后可以导出xml文件,让项目组其他同事按照此方法导入配置文件,这样项目中的注释风格就一致了,看起来比较清晰明了。
相关推荐
为MyEclipse添加注释模板(定制代码注释格式)
myeclipse简单注释模板
MyEclipse注释模板下载,codetemplates模板
MyEclipse_(注释模板).doc
eclipse/myeclipse注释模板 支持直接导入方便快捷非常好用,本人又新添加很多功能 需配合我上传过的文件使用
Eclipse&MyEclipse_(注释模板详细)
MyEclipse 增加注释模板,只需要替换里面的名字就行,代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。...
MyEclipse注释模板,包括对生成类模板的注释等等....
myeclipse注释模板,方便为代码添加注释
myeclipse java代码注释导入模板 Preferences->Java->Code Style->import就可以; 也可以根据自己的代码注释规范修改这个xml文件
修改下用户名,导入即可使用,其他的可以酌情修改,导入路径Window>Prepercences>Java>Code Style > Code Templates 点击导入,选择此模板。
eclipse myeclipse注释模板
MyEclipse Java code style 注释模板 xml 很通用的注释模板 操作方法: windows->Preferences->Java ->code style 导入xml文件即可 添加注释的快捷键是alt+shfit+J
这是一个通用的eclipse代码注释目标,排版非常的整齐,
NULL 博文链接:https://xylonwang.iteye.com/blog/438646
一键导入注释模板
MyEclipse中设置java注释模板的方法.docx
eclipse/Myeclipse注释模板,导入即可使用,内附导入操作说明。
1、Window---Preference---Java---Code Style---Code Templates 2、选择Comments---Import