咱们在写一个类时,常常会给这个类作注释,但是一个项目中可能有不少类,怎么样才能让它本身生成注释呢?下面,就让我把本身使用的方法写出来,以便之后的查找和翻阅。首先声明的是,我用的是mac本,eclipse也是适用于mac的。这里介绍两种方法。 php
第一种方法具体操做步骤以下: java
(1)首先选中一个eclipse中的项目。由于在eclipse中,咱们可能安装了不少插件,以即可以支持java,android,c,c++及php等,每一种语言的属性多是不一样的,因此,若是你的项目中安装了两种以上语言的插件,请先选中一个项目。由于我是作android的开发的,因此,我选中一个android的项目,以此为例来记录eclipse中注释的设置; android
(2)依次点击:Project—>Properties—>Java Code Style—>Code Templates; c++
(3)在“Enable project specific settings”前面打上对勾; app
(4)接着依次点击:Comments—>Types—>Edit; eclipse
(5)在弹出的窗口中填上以下代码: ide
/** ui
* spa
*项目名称:${project_name} 插件
*类名称:${type_name}
*类描述:
*建立人:${user}
*建立时间:${date} ${time}
*
*/
(6)在“Automatically add comments for new methods and types”前打上对勾。这步很重要,若是不打的话,就不能在建立类的时候自动添加注释。
(7)最后点击“apply”,“ok”,完成。
第二种方法:
创建一个codetemplates.xml文件,内容为
<?xml version="1.0" encoding="UTF-8"?><templates><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} : set the property ${bare_field_name}. */</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 用一句话描述该文件作什么 * @author zdq * @update ${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">/** * ${tags} * ${see_to_target} */</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">/** * @description 这里用一句话描述这个类的做用 * @version 1.0 * @author zdq * @update ${date} ${time} */
</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">/* (non-Javadoc) * ${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} */ </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">/** * ${tags} * @description 用一句话说明这个方法作什么 * @version 1.0 * @author zdq * @update ${date} ${time} */</template><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">/** * @return ${bare_field_name} : return the property ${bare_field_name}. */</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">/** * 类的构造方法 * ${tags} */</template></templates>
在Project—>Properties—>Java Code Style—>Code Templates下的Code Comments中import该文件便可。