项目代码注释模板约定

在代码中,使用统一的注释模板,进行统一格式化处理。

打开Window->Preferences->Java->Code Style->Code Templates,把codetemplates.xml导入。

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
 * ${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">/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author Xu,Jin [email protected]
* @date ${date} ${time}
*
* ${tags}
*/ </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="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 Xu,Jin [email protected]
* @date ${date} ${time}
* @website:http://www.xujin.org
* @version V1.0
*/ </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">/* (non-Javadoc)
 * ${see_to_overridden}
 */</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">/**
 * ${tags}
 * ${see_to_target}
 */</template><template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
 *
 */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
 * ${tags}
 */</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></templates>

  

时间: 2024-11-04 10:13:23

项目代码注释模板约定的相关文章

idea配置代码注释模板

从eclipse换成idea后,有点不习惯,其中之一就是代码注释,感觉不如eclipse好用,下面是一些配置方法,配完之后差不多能实现eclipse的效果. 1.以配置Class的注释为例,其他文件的类似,打开File - settings之后,找到下图的位置,选中Class后修改备注,变量和参数跟eclipse差不多就不多讲了.配置完这里后再新建class就会应用新的注释模板了,但是我也只能发现新建的时候应用,如果已有方法还是不会自动引用,只能手动维护. 可以随意定义自己的备注格式,这里只做演

Eclipse/MyEclipse怎么设置个性化代码注释模板

打开Eclipse/MyEclipse工具,打开或创建一个Java工程,点击菜单Window->Preferences弹出首选项设置窗口 展开左侧Java->Code Style->Code Template选项列表,就可以看到所有需设置注释的元素了 展开右侧模板选项Comments,可以看到可以设置的注释模板类型,包含Files,Types,Fields,Constructors,Methods等内容 点击Types,下方Pattern区域会显示类注释模板内容,点击右则的Edit按钮可

MyEclipse怎么设置个性化代码注释模板

打开Eclipse/MyEclipse工具,打开或创建一个Java工程,点击菜单Window->Preferences弹出首选项设置窗口   展开左侧Java->Code Style->Code Template选项列表,就可以看到所有需设置注释的元素了   展开右侧模板选项Comments,可以看到可以设置的注释模板类型,包含Files,Types,Fields,Constructors,Methods等内容   点击Types,下方Pattern区域会显示类注释模板内容,点击右则的E

Eclipse代码注释模板-code template

参考帖子blog.csdn.net/security08/article/details/5588013 操作步骤:打开Window->Preferences->Java->Code Style->Code Templates 如图: 点击“Import”,导入模板codetemplates.xml文件. 附:codetemplates.xml文件内容 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

MyEclipse设置Java代码注释模板

在类和方法上方输入/** 然后回车出现的注释模版设置.   文件 (Files)注释标签: /**   * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author name * @date ${date} */ 类型 (Types)注释标签(类的注释): /** * ClassName: ${type_name}  * @Description: ${todo} * @author nam

visual studio 设置代码注释模板

1.C#模板文件: 路径:C:\Program Files (x86)\Microsoft Visual Studio 14.0\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class\Class.cs #region << 版 本 注 释 >> /* * ======================================================================== * Copyright Notice 2

STS 设置代码注释模板

打开Window->Preferences->Java->Code Style->Code Templates 1 <?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="gettercomment_context&

使用Visual Studio扩展插件Visual assist X给代码插入注释模板

Visual Assist 是由Whole Tomato公司为Microsoft Visual Studio开发的一款插件.它对Visual Studio的智能提示功能和代码高亮功能进行了增强,同时还增加了代码提示功能和重构功能,并对程序注释加入了拼写检查功能.它还可以检测一些基本的语法错误,如使用未声明的变量等. 今天使用这款插件,主要是为了能够进行快速插入注释模板.一个是为了提高编码效率,不用每次都手动一行一行的添加注释:另一个是为了规范代码,因为插入的是模板,保证了注释的一致性,提高代码可

Android Studio迁移代码风格与注释模板

在使用AS中,感觉系统自带的字体的颜色等不是自己想要的,所以就想的自己配置一种喜欢的字体风格,步骤如下:(工作环境为ubuntu14.10,AS为1.3.2) 1.点击File--->Settings--->Editor---->Colors & Fonts,点击Save AS--->重新命名(举例LJStyle) 2.然后可以在Colors & Fonts下拉列表中选中java,配置自己想要的颜色. 3.当需要将你的这个配置导入到其他设备的AS中,点击File--