文档注释快捷键

eclipse下，当鼠标处于类，方法定义行时，按Alt+Shift+J或Shift+Alt+J，快速添加文档注释

 

 

#2012/6/5 write

简单的设置一个在创建一个新的class文件是，文件头部自动生成作者信息

 

 

 

内容：

${filecomment}

${package_declaration}

/**

*

* @author Sv

*/

${typecomment}

${type_declaration}

 

 

#2013/5/16 write

新建类、接口文件时自动生成文件注释，上面写的就是这种

但这只会在创建时才会自动生成，如果手动生成怎么办呢？

 

下面就来介绍：

1.手动在类或接口或java文件上生成文件模版注释，Code Templates》Comments》Types

 

2.手动在方法上生成方法模版注释，Code Templates》Comments》Methods

 

好了，我只演示了两个经常用的到的，其他比如Constructor构造方法上，getter方法上等需要的时候再加吧

 

 

备份的代码注释模版

---

#DDDD工作时，个人

<?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="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="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**

* TODO 方法XXX的简要说明 XXXX&lt;br&gt;&lt;pre&gt;

* 方法XXX的详细说明 &lt;br&gt;

* 编写者：Sv

* Email：applec@company.com

* 创建时间：${date} ${time}&lt;/pre&gt;

* @param 参数类型 参数名 说明

* @return ${return_type} 说明

* @throws 异常类型 说明

*/</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="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**

*

*/</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="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="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">//******************************************************************&#13;

/** &lt;pre&gt;&#13;

* 类名：${package_name}.${type_name}&#13;

* 描述：${todo} XXXX&#13;

* 基本思路：&#13;

* public方法：&#13;

* 特别说明：&#13;

* 编写者：Sv&#13;

* Email：applec@company.com&#13;

* 版权: Copyright (C) 2013 DDDD版权所有&#13;

* 创建时间：${date} ${time}&#13;

* 修改说明：类的修改说明&#13;

* &lt;/pre&gt;&#13;

*/&#13;

//******************************************************************</template></templates>

 

 

参考文档：