关于文档注释规范

关于文档注释规范

准备工作：

 

双击打开文件夹

 

用editplus或其他编辑器打开

 

修改配置文件中：

 

 

引入配置文件：

Step1:将模板配置文件放在myeclipse的安装目录下

 

 

Step2:window ---> preference

 

Step3:导入配置文件

 

 

 

 

使用：

Step1:

 

Step2:则会自动生成注释，按上面的要求写注释

 

关于编码规范

参考《华为编码规范》文档。

附录：

<?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}, fhlin0611@foxmail.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} &lt;br/&gt;

 * Function: ${todo} ADD FUNCTION. &lt;br/&gt;

 * Reason: ${todo} ADD REASON(可选). &lt;br/&gt;

 * date: ${date} ${time} &lt;br/&gt;

 *

 * @author Dante Fung

 * @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}:(这里用一句话描述这个方法的作用). &lt;br/&gt;

 * ${todo}(这里描述这个方法适用条件 – 可选).&lt;br/&gt;

 * ${todo}(这里描述这个方法的执行流程 – 可选).&lt;br/&gt;

 * ${todo}(这里描述这个方法的使用方法 – 可选).&lt;br/&gt;

 * ${todo}(这里描述这个方法的注意事项 – 可选).&lt;br/&gt;

 *

 * @author Dante Fung

 * ${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} 简单描述该方法的实现功能（可选）.

 * ${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="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}, fhlin0611@foxmail.com All Rights Reserved.

 *

*/

${filecomment}

${package_declaration}

/**

 * ClassName:${type_name} &lt;br/&gt;

 * Function: ${todo} ADD FUNCTION. &lt;br/&gt;

 * Reason: ${todo} ADD REASON. &lt;br/&gt;

 * Date:     ${date} ${time} &lt;br/&gt;

 * @author   Dante Fung

 * @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>

来自为知笔记(Wiz)