在类eclipse的IDE中,我们经常要使用到注释,所以默认自动注释格式,给了我们很大的帮助,但是默认的格式中描述过于简单,我们使用不便,本是将充分介绍自动注释的使用,并附上通用的格式文件,看客可以进行自我修改,以便符合自己的使用要求!
接下来我们就详细介绍设置的过程:
注释格式及设置步骤方式:
Window -> Preferences -> Java -> Code Style -> Code Templates -> Comment中有许多的自动格式实例,我们需要通过这些实例来达到一个符合自己要求的注释
例如我们希望在一个Java文件的开头设置作者作者信息以及日期信息。
选择Types,点击Edit,将
/**
* @author ${user}
* ${tags}
*/
将${user}删除,改成hanyankai,这样作者信息就变成hanyankai;点击Insert Variable,选择Date,这样就会自动生成日期信息。
设置完以后我们测试一下,自动生成的注释信息为:
/**
* @author hanyankai
* 2009-11-27
*/
同样的步骤,我们也可以对其他例如构造函数等等注释信息进行编辑设置。
使用时鼠标放置在需要添加注释的方法内部的任意位置。点击菜单栏中【源代码】下的【添加Javadoc注释】,或者使用快捷键Alt Shift J,则eclipse自动在该方法前面添加注释。
注释的规范如下:
文件注释标签:
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2007</p>
* <p>Company: zkyr</p>
* @author Uu
* @date ${date}
* @version 1.0
*/
类型注释标签(类的注释):
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* <p>Company: zkyr</p>
* @author Uu
* @date ${date}
*/
字段注释标签:
/** ${field}*/
构造函数标签:
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法标签:
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
覆盖方法标签:
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法标签:
/**
* ${tags}
* ${see_to_target}
*/
getter方法标签:
/**
* @return ${bare_field_name}
*/
setter方法标签:
/**
* @param ${param} 要设置的 ${bare_field_name}
*/
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<templates>
<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="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="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="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: ${user}
* @date: ${date} ${time}
* @version: V1.0
*/
</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">/**
* @author: ${user}
* @Description: TODO
* @date: ${date} ${time}
* ${tags}
*/
</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="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}
* @throws:
*/
</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">/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${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="newtype_context" deleted="false"
description="Newly created files" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">${filecomment}
${package_declaration}
${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="true" 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>