IT博客汇 | 丰富eclipse注解的内容

丰富eclipse注解的内容

summer发表于 2016-06-22 00:46:11

如何丰富eclipse注解的内容

eclipse -> Window -> Preferences -> Code Templates -> Comments (Comments代表注释模板)

1、 Files（Java文件注释）

/**
* Project Name:{project_name}
* File Name:{file_name}
* Package Name:{package_name}
* Date:{date}{time}
* Copyright (c) {year}, chenzhou1025@126.com All Rights Reserved.
*/

2、Types（Java类注释）

/**
* ClassName: {type_name} <br/>
* Function: {todo} ADD FUNCTION. <br/>
* Reason: {todo} ADD REASON(可选). <br/>
* date: {date} {time} <br/>
* @author {user}
* @version {enclosing_type}{tags}
* @since JDK 1.6
*/

3、Fields（类字段注释）

/**
* {field}:{todo}(用一句话描述这个变量表示什么).
* @since JDK 1.6
*/

4、Constructors（构造函数注释）

/**
* Creates a new instance of {enclosing_type}.
* {tags}
*/

5、Methods（Java方法注释）

/**
* {enclosing_method}:(这里用一句话描述这个方法的作用). <br/>
* {todo}(这里描述这个方法适用条件 – 可选).<br/>
* {todo}(这里描述这个方法的执行流程 – 可选).<br/>
* {todo}(这里描述这个方法的使用方法 – 可选).<br/>
* {todo}(这里描述这个方法的注意事项 – 可选).<br/>
* @author {user}
* {tags}
* @since JDK 1.6
*/

6、Overriding methods（重写方法注释）

/**
* {todo} 简单描述该方法的实现功能（可选）.
* {see_to_overridden}
*/

7、Delegate methods（代理方法注释）

/**
* {tags}
* {see_to_target}
*/

8、Getters（Java Getter方法注释）

/**
* {bare_field_name}.
* @return the {bare_field_name}
* @since JDK 1.6
*/

9、Setters（Java Setters方法注释）

/**
* {param}.
* @param {param} the {bare_field_name} to set
* @since JDK 1.6
*/

eclipse -> Window -> Preferences -> Code Templates -> Code (Code代表代码模板)

1、New Java files（新建java文件代码模板）

/**
* Project Name:{project_name}
* File Name:{file_name}
* Package Name:{package_name}
* Date:{date}{time}
* Copyright (c) {year}, chenzhou1025@126.com All Rights Reserved.
*
*/
{filecomment}

2、Method body（方法体模板）

// {todo} Auto-generated method stub
{body_statement}

3、Constructor body（构造函数模板）

{body_statement}
// {todo} Auto-generated constructor stub

4、Getter body（字段Getter方法模板

return {field};

5、Setter body（字段Setter方法模板）

{field} = {param};

6、Catch block body（异常catch代码块模板）

// {todo} Auto-generated catch block
{exception_var}.printStackTrace();

详细codetemplates.xml如下所示：

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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">/**
* {bare_field_name}.
*
* @return the {bare_field_name}
* @since JDK 1.6
*/</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 {param} the {bare_field_name} to set
* @since JDK 1.6
*/</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">/**
* Creates a new instance of {enclosing_type}.
*
* {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">/**
* Project Name:{project_name}
* File Name:{file_name}
* Package Name:{package_name}
* Date:{date}{time}
* Copyright (c) {year}, chenzhou1025@126.com All Rights Reserved.
*
*/</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} <br/>
* Function: {todo} ADD FUNCTION. <br/>
* Reason: {todo} ADD REASON(可选). <br/>
* date: {date} {time} <br/>
*
* @author {user}
* @version {enclosing_type}{tags}
* @since JDK 1.6
*/</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}(用一句话描述这个变量表示什么).
* @since JDK 1.6
*/</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}:(这里用一句话描述这个方法的作用). <br/>
* {todo}(这里描述这个方法适用条件 – 可选).<br/>
* {todo}(这里描述这个方法的执行流程 – 可选).<br/>
* {todo}(这里描述这个方法的使用方法 – 可选).<br/>
* {todo}(这里描述这个方法的注意事项 – 可选).<br/>
*
* @author {user}
* {tags}
* @since JDK 1.6
*/</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">/**
* {todo} 简单描述该方法的实现功能（可选）.
* {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="false" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">/**
* Project Name:{project_name}
* File Name:{file_name}
* Package Name:{package_name}
* Date:{date}{time}
* Copyright (c) {year}, chenzhou1025@126.com All Rights Reserved.
*
*/
{filecomment}

{package_declaration}
/**
* ClassName:{type_name} <br/>
* Function: {todo} ADD FUNCTION. <br/>
* Reason: {todo} ADD REASON. <br/>
* Date: {date} {time} <br/>
* @author {user}
* @version
* @since JDK 1.6
* @see
*/
{typecomment}
{type_declaration}
</template><template autoinsert="true" context="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody">
</template><template autoinsert="true" context="interfacebody_context" deleted="false" description="Code in new interface type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name="interfacebody">
</template><template autoinsert="true" context="enumbody_context" deleted="false" description="Code in new enum type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody">
</template><template autoinsert="true" context="annotationbody_context" deleted="false" description="Code in new annotation type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name="annotationbody">
</template><template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock">
// {todo} Auto-generated catch block
{exception_var}.printStackTrace();
</template><template autoinsert="false" context="methodbody_context" deleted="false" description="Code in created method stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody">
// {todo} Auto-generated method stub
{body_statement}</template><template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name="constructorbody">
{body_statement}
// {todo} Auto-generated constructor stub
</template><template autoinsert="true" context="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody">return {field};</template><template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody">{field} = {param};</template></templates>