Eclipse 的快捷键以及文档注释

墨蓝 2022-01-22 00:01 334阅读 0赞

# 1.多行注释快捷键 #

1.选中你要加注释的区域，用ctrl+shift+C 或者ctrl+/ 会加上//注释  
2.先把你要注释的东西选中，用shit+ctrl+/ 会加上/\*    \*/注释

3.以上快捷在重复按一下就会去掉加上的注释  
4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了

## 2.Eclipse中添加文档注释快捷键 ##

1.例如默认的文档注释：

/**
             * @author XX
             *
             */

2.快捷键为：ALT + SHIFT +J

3.修改文档注释的注释格式内容，修改的方法有两种：

A.直接在eclipse给的模板下进行修改

打开eclipse

Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit

例如：

/**   
    *    
    * 项目名称：${project_name}   
    * 类名称：${type_name}   
    * 类描述：   
    * 创建人：${user}   
    * 创建时间：${date} ${time}   
    * @version        
    */

B.自己编写一个xml文档导入进去

打开eclipse

Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> import

选择你写好的模板.xml文件,以下是一个编好的文档

<?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">/**
     * @return the ${bare_field_name}
     */</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">/**
     * <p/>@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/>Date ${date} ${time} 
     * <p/>@author ieflex
     * ${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">/**
     * <p/>Date ${date} ${time} 
     */</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">/**
     *
     * <p/>Date ${date} ${time} 
     * <p/>@author ieflex
     */</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">/**
     * 
     * <p/>Date ${date} ${time}
     * <p/>@author ieflex
     */</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">/**
     * 
     * <p/>Date ${date} ${time} 
     * <p/>@author ieflex
     * ${tags}
     */</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}
     * <p/>Date ${date} ${time} 
     * <p/>@author ieflex
     */</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}
     * <p/>Date ${date} ${time} 
     * <p/>@author ieflex
     */</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>