天天看点

MyEclipse6.5 注释类及方法等格式设置(Code Templates)

这是我的百度空间里的一篇博文,地址:http://hi.baidu.com/winters1224/blog/item/ebcbb10b701d00f8aa645700.html。原文如下:

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

文件(Files)注释标签:

/**   

* @Title: ${file_name} 

* @Package ${package_name} 

* @Description: ${todo}(用一句话描述该文件做什么) 

* @author A18ccms A18ccms_gmail_com   

* @date ${date} ${time} 

* @version V1.0   

*/

类型(Types)注释标签(类的注释):

/** 

* @ClassName: ${type_name} 

* @Description: ${todo}(这里用一句话描述这个类的作用) 

* @author A18ccms a18ccms_gmail_com 

* ${tags} 

字段(Fields)注释标签:

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 

*/ 

构造函数标签:

* <p>Title: </p> 

* <p>Description: </p> 

方法(Constructor & Methods)标签:

* @Title: ${enclosing_method} 

* @Description: ${todo}(这里用一句话描述这个方法的作用) 

* @param ${tags}    设定文件 

* @return ${return_type}    返回类型 

* @throws 

覆盖方法(Overriding Methods)标签:

/* (非 Javadoc) 

* <p>Title: ${enclosing_method}</p> 

* ${see_to_overridden} 

代表方法(Delegate Methods)标签:

* ${see_to_target} 

getter方法标签:

* @return ${bare_field_name} 

setter方法标签:

* @param ${param} 要设置的 ${bare_field_name} 

例子: 

<?xml version="1.0" encoding="UTF-8"?> 

<templates> 

    <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"> 

    /**   

     * 创建一个新的实例 ${enclosing_type}.   

     *   

     * ${tags}   

     */   

    </template> 

                autoinsert="true"    

                context="settercomment_context" 

                description="Comment for setter method"    

                id="org.eclipse.jdt.ui.text.codetemplates.settercomment"    

                name="settercomment"> 

     * @param ${param} the ${bare_field_name} to set   

    <template 

                context="methodcomment_context"    

                description="Comment for non-overriding methods"    

                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"    

                name="methodcomment"> 

     * 此方法描述的是:   

     * @version: ${date} ${time}   

                context="delegatecomment_context"    

                description="Comment for delegate methods"    

                id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"    

                name="delegatecomment"> 

     * ${see_to_target}   

                context="filecomment_context"    

                description="Comment for created Java files"    

                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"    

                name="filecomment"> 

     * 文件名:${file_name}   

     * 版本信息:   

     * 日期:${date}   

     * Copyright 足下 Corporation ${year}    

     * 版权所有   

                context="gettercomment_context"    

                description="Comment for getter method"    

                id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"    

                name="gettercomment"> 

     * ${bare_field_name}   

     * @return the ${bare_field_name}   

     * @since   CodingExample Ver(编码范例查看) 1.0   

    */   

                context="overridecomment_context"    

                description="Comment for overriding methods"    

                id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"    

                name="overridecomment"> 

    /* (non-Javadoc)   

     * ${see_to_overridden}   

                context="fieldcomment_context"    

                description="Comment for fields"    

                id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"    

                name="fieldcomment"> 

     * ${field}:${todo}(用一句话描述这个变量表示什么)   

     * @since Ver 1.1   

                context="typecomment_context"    

                description="Comment for created types"    

                id="org.eclipse.jdt.ui.text.codetemplates.typecomment"    

                name="typecomment"> 

     * 此类描述的是:   

     * @version: ${date} ${time}    

</templates> 

                autoinsert="false" 

                  context="constructorcomment_context" 

                deleted="false" 

                description="Comment for created constructors" 

                enabled="true" 

    /** 

     * 创建一个新的实例 ${enclosing_type}. 

     * 

     * ${tags} 

     */ 

                autoinsert="true" 

                description="Comment for setter method" 

                id="org.eclipse.jdt.ui.text.codetemplates.settercomment" 

     * @param ${param} the ${bare_field_name} to set 

                context="methodcomment_context" 

                description="Comment for non-overriding methods" 

                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" 

     * 此方法描述的是: 

     * @version: ${date} ${time} 

                context="delegatecomment_context" 

                description="Comment for delegate methods" 

                id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" 

     * ${see_to_target} 

                context="filecomment_context" 

                description="Comment for created Java files" 

                id="org.eclipse.jdt.ui.text.codetemplates.filecomment" 

     * 文件名:${file_name} 

     * 版本信息: 

     * 日期:${date} 

     * Copyright 足下 Corporation ${year} 

     * 版权所有 

                context="gettercomment_context" 

                description="Comment for getter method" 

                id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" 

     * ${bare_field_name} 

     * @return the ${bare_field_name} 

     * @since   CodingExample Ver(编码范例查看) 1.0 

    */ 

    </template>

                context="overridecomment_context" 

                description="Comment for overriding methods" 

                id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" 

    /* (non-Javadoc) 

     * ${see_to_overridden} 

                context="fieldcomment_context" 

                description="Comment for fields" 

                id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" 

     * ${field}:${todo}(用一句话描述这个变量表示什么) 

     * @since Ver 1.1 

                context="typecomment_context" 

                description="Comment for created types" 

                id="org.eclipse.jdt.ui.text.codetemplates.typecomment" 

     * 此类描述的是: 

</templates>

MyEclipse 6.5 代 码提示的设置

MyEclipse 选择 Windows ->Preperences ->General ->keys

找到 word completion的快捷键 把原alt+/删掉!//必须

把Content Assist 的快捷键 改成alt+/ 或者你想改的其他快捷键

MyEclipse编码 设置

Myeclipse安装后编码默认是GB18030,一般推荐用UTF-8。如果在导入项目后发现乱码现象,那是编码设置设 置不对。

全局编码设置的方法:ToolBar-->Window-->Preferences-->General-->Workspace-->Text file encoding,设置合适的编码。

局部编码 设置:在源码按右键-->General-->Editors-->Test Editors-->Spelling-->Encoding,这里是设置单个文件的编码。

推荐还是 使用全局编码设置。

MyEclipse设置JSP页面默认编码方 式:

windows(窗口)-Preferences(首选项)-MyEclipse-Files & Editors-JSP-右 侧encoding:设 置为ISO10646/Unicode(UTF-8)

MyEclipse在Java文件中设置作 者、日期等说明:

windows(窗口)-Preferences(首选项)-Java-Code Style(代码样式)-Code Templates(代码模版)-右侧Comments(注释)-选择Types(类型)-点击edit(编辑)-输入如下信息

/**

* @包名   ${package_name}

* @文件名 ${file_name}

* @作者   NoureWang

* @创建日期 ${date}

* @版本 V 1.0

点击OK(确定)-选中左侧的代码样式-选择右侧复选框(Automatically add Comments for new Methods and types)(自动为新方法和类型添加注释)-点击Apply(应用)-点击OK(确 定)

eclipse里面有 一个spell check的开关,把它关了。具体操作windows->preference->输入spell

自动提示:具体操作 windows->preference->输入content assist    选择Java->editor->content assist

Auto activation triggers for Java:后面输入.abcdefghijklmnopqrstuvwxyz 确定

然后导出。

==========转载结束=============

为了回报耐心看到这里的同志哥,补充两点。

1、用Eclipse导出javadoc时,如果java的编码方式是utf-8,那么导出的javadoc中会出现乱码。这种情况,需要在Eclipse导出javadoc向导的最后一页的Extra JavaDoc Options 里填上:-encoding UTF-8 -charset UTF-8。当然,如果是其它编码方式,就填对应的编码方式。

2、Eclipse导出javadoc的时候,上文中的很多标签不会被识别。如@Title,@Packag等。ms是因为javadoc中标准的标签只有少数几个。是哪几个呢?我记在另一篇博客里了……

继续阅读