MyEclipse设置Java代码注释模板

合集下载

java文档注释规范（一）

java⽂档注释规范（⼀）https:///huangsiqian/article/details/82725214Javadoc⼯具将从四种不同类型的“源”⽂件⽣成输出⽂档：Java语⾔类的源⽂件（.java），包注释⽂件，概述注释⽂件和其他未处理的⽂件。

包注释⽂件（Package Comment File）每个包都有⾃⼰的⽂档注释。

有两种⽅式来创建包注释⽂件：package-info.java - 可以包含包的声明，包注解（anotation），包注释和Javadoc 标签（tag）。

包注释放在包声明之前。

这是JDK 5.0新引⼊的特性。

如下。

File: java/applet/package-info.java 注意：⽂档注释块内部⾏⾸的*号是可选的/*** Provides the classes necessary to create an applet and the classes an applet uses* to communicate with its applet context.* <p>* The applet framework involves two entities:* the applet and the applet context. An applet is an embeddable window (see the* {@link java.awt.Panel} class) with a few extra methods that the applet context* can use to initialize, start, and stop the applet.** @since 1.0* @see java.awt*/package ng.applet;package.html - 只能包含包注释和Javadoc标签，不能包含包注解。

MyEclipse编码设置

MyEclipse编码设置一、设置新建常见类型文件的默认编码格式，也就是文件保存的格式。

在不对MyEclipse进行设置的时候，默认保存文件的编码，一般跟简体中文操作系统（如windows2000，windowsXP）的编码一致，即GBK。

在简体中文系统下，ANSI 编码代表GBK编码;在日文操作系统下，ANSI 编码代表JIS 编码。

Window-->Preferences-->General -->content Types在右侧窗口中展开每一个子项,依次输入编码格式，如“UTF-8”点击“update”就设置好了。

例如：在以上设置中，设置jsp默认编码格式为“UTF-8”，那么以后新建的jsp文件，都是以“UTF-8”的格式保存的。

同样设置java默认编码格式为“UTF-8”，那么以后新建的java文件，都是以“UTF-8”的格式保存的。

设置html默认编码格式为“UTF-8”，那么以后新建的html文件，都是以“UTF-8”的格式保存的。

以上设置了文件的保存编码格式，默认的打开方式（解码方式）会跟保存编码格式一样。

二、设置新建其他文件的默认编码格式，即文件保存格式。

在第一项设置中，只是设置了常用文件类型的编码格式。

如果新建一个文件，没有后缀名，也就是不指名文件类型，那么MyEclipse无法判断该用何种编码格式保存，就用操作系统默认文件保存编码格式GBK进行保存。

这个默认保存编码格式，可用如下方法修改：window-->preferences-->general-->workspace 在右侧Text file encoding->Other 选择UTF-8三、单个文件查看编码格式（也就是打开文件用的编码格式）更改。

这个方法没有更改文件的编码格式，只是告诉MyEclipse用何种编码格式进行解码。

在要查看的文件上，如文件Test.java上右键-->Properties-->Resource在右侧Text file encoding ->Other，可以进行修改。

Maven搭建MyEclipse10+Struts2.1+Spring3.3+Hibernate3.3全注解框架

一、新建项目1.新建maven项目New ->project选择Maven projectnext在filter输入webapp选择maven-archetype-webappGroup id输入inscribe，artifact id输入farsighted二、添加struts2框架1.添加struts2支持项目上点右键->myeclipse->add struts capabilities点选struts2.1和/*只勾选struts2 core lib启动tomcat，在地址栏输入localhost:8088/farsighted出现如下界面2.添加action类New ->source folder输入src/main/javaNew ->classPackage输入org.inscribe.farsighted.action，name输入LoginActionLoginAction.javapackage org.inscribe.farsighted.action;import org.apache.struts2.convention.annotation.Action;import org.apache.struts2.convention.annotation.ParentPackage; import org.apache.struts2.convention.annotation.Result;import com.opensymphony.xwork2.ActionSupport;/*** @author steve frank**/@ParentPackage("struts-default")public class LoginAction extends ActionSupport {private String name;private String password;public String getName() {return name;}public void setName(String name) { = name;}public String getPassword() {return password;}public void setPassword(String password) {this.password = password;}@Action(value = "login", results = {@Result(name = INPUT, location = "/WEB-INF/content/fail.jsp"),@Result(name = SUCCESS, location = "/WEB-INF/content/success.jsp") }) public String execute() {if (name.equals("steve") && password.equals("123"))return SUCCESS;elsereturn INPUT;}}Index.jsp<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%><%@ taglib prefix="s" uri="/struts-tags"%><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><title>My JSP 'index.jsp' starting page</title></head><body><s:form action="login"><s:textfield name="name" value="steve"></s:textfield><s:textfield name="password" value="123"></s:textfield><s:submit></s:submit></s:form></body></html>success.jsp<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> <%@ taglib prefix="s" uri="/struts-tags"%><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><title>My JSP 'success.jsp' starting page</title></head><body><s:text name="password" /><hr /><s:property value="password" /></body></html>fail.jsp<body>登录失败,用户名或密码错误.</body>三、添加hibernate框架1.添加hibernate支持右键->myeclipse->add hibernate capabilities点选hibernate 3.3 勾选enable hibernate annotations support勾选hibernate 3.3 annotations&entity manager,hibernate 3.3 core lib,hibernate 3.3 advanced support lib点选copy checked library jars to folder and add to build-path点选newFolder :src/main/resources勾选open configuration file选择db driver:mysql去掉勾，不创建hibernatesessionfactory四、添加spring框架1.添加spring支持项目右键->myeclipse->add spring capabilities点选spring3.0勾选spring 3.0 core;spring 3.0 aop;spring3.0 persistence core; spring3.0 persistence jdbc; 勾选copy checked library contents to project folder采取默认，enable aop,new applicationcontext.xml不创建sessionfactory2.applicationContext.xml文件配置<?xml version="1.0" encoding="UTF-8"?><beans xmlns="/schema/beans"xmlns:xsi="/2001/XMLSchema-instance"xmlns:context="/schema/context"xmlns:aop="/schema/aop"xmlns:tx="/schema/tx"xsi:schemaLocation="/schema/beans/schema/beans/spring-beans.xsd/schema/context/schema/context/spring-context.xsd/schema/aop/schema/aop/spring-aop.xsd/schema/tx/schema/tx/spring-tx.xsd"> <bean id="sessionFactory"class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBea n"><property name="configLocation" value="classpath:hibernate.cfg.xml"></property><property name="packagesToScan" value="org.inscribe.farsighted.model" /> </bean><context:component-scan base-package="org.inscribe.farsighted" /><bean id="transactionManager"class="org.springframework.orm.hibernate3.HibernateTransactionManager"><property name="sessionFactory" ref="sessionFactory" /></bean><tx:annotation-driven transaction-manager="transactionManager"proxy-target-class="true" /></beans>3.hibernate.cfg.xml修改<?xml version='1.0' encoding='UTF-8'?><!DOCTYPE hibernate-configuration PUBLIC"-//Hibernate/Hibernate Configuration DTD 3.0//EN""/hibernate-configuration-3.0.dtd"><hibernate-configuration><session-factory><property name="dialect">org.hibernate.dialect.MySQLDialect</property><property name="connection.url">jdbc:mysql://localhost:3306/test</property><property name="ername">root</property><property name="connection.password">admin</property><property name="connection.driver_class">com.mysql.jdbc.Driver</property><property name="myeclipse.connection.profile">MYSQL</property><property name="initialSize">5</property><property name="maxActive">100</property><property name="maxIdle">30</property><property name="maxWait">500</property><property name="defaultAutoCommit">false</property></session-factory></hibernate-configuration>4.web.xml文件配置<?xml version="1.0" encoding="UTF-8"?><web-app version="3.0" xmlns="/xml/ns/javaee"xmlns:xsi="/2001/XMLSchema-instance"xsi:schemaLocation="/xml/ns/javaee/xml/ns/javaee/web-app_3_0.xsd"><display-name></display-name><welcome-file-list><welcome-file>index.jsp</welcome-file></welcome-file-list><context-param><param-name>contextConfigLocation</param-name><param-value>classpath*:applicationContext*.xml</param-value></context-param><listener><listener-class>org.springframework.web.context.ContextLoaderListener</listener-class ></listener><filter><filter-name>struts2</filter-name><filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter </filter-class></filter><filter-mapping><filter-name>struts2</filter-name><url-pattern>/*</url-pattern></filter-mapping><filter><filter-name>Set Character Encoding</filter-name><filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class><init-param><param-name>encoding</param-name><param-value>UTF-8</param-value></init-param><init-param><param-name>forceEncoding</param-name><param-value>true</param-value></init-param></filter><filter-mapping><filter-name>Set Character Encoding</filter-name><url-pattern>/*</url-pattern></filter-mapping></web-app>五、类的添加1.hibernate反向生成students表右键->hibernate reverse engineering选择package : com.inscribe.farsighted.model勾选create pojo<>db->点选add hibernate mapping annotations to pojo;勾选update hibernate configuration with mapping resource location勾选java data access object(dao)->勾选generate precise findby methods;点选sping daoId generation :native2.添加service接口package org.inscribe.farsighted.service;import org.inscribe.farsighted.model.Student;public interface StudentService {public Student findById(Integer id);}3.添加service实现类package org.inscribe.farsighted.service.impl;import javax.annotation.Resource;import org.inscribe.farsighted.model.Student;import org.inscribe.farsighted.model.StudentDAO;import org.inscribe.farsighted.service.StudentService;import org.springframework.stereotype.Service;@Servicepublic class StudentServiceImpl implements StudentService {@Resourceprivate StudentDAO studentDAO;@Overridepublic Student findById(Integer id) {// TODO Auto-generated method stubreturn studentDAO.findById(id);}}4.添加测试类package org.inscribe.farsighted;import org.inscribe.farsighted.model.Student;import org.inscribe.farsighted.service.StudentService;import org.springframework.context.ApplicationContext;import org.springframework.context.support.ClassPathXmlApplicationContext;public class Test {public static void main(String[] args) {ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");StudentService service = (StudentService) context.getBean("studentServiceImpl");Student s=service.findById(1);System.out.println(s.getName());}}5.WEB-INF下新建Folder包结构如下6.修改输出目录Build path->configure build pathOut folder统一改default：Webapp/src/main/webapp/WEB-INF/classes更改如果无效,在pom.xml中<build>……</build>添加<sourceDirectory>src/main/java</sourceDirectory><resources><resource><directory>src/main/resources</directory></resource></resources><outputDirectory>src/main/webapp/WEB-INF/classes</outputDirectory>7.添加struts-spring支持(action注解配置支持)Build path->add librariesMyeclipse libraries勾选struts 2 spring libraries8.修改struts.xml<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration2.1//EN" "/dtds/struts-2.1.dtd"><struts><constant name="struts.devMode" value="true" /><constant name="struts.objectFactory" value="spring" /><constant name="struts.i18n.encoding" value="UTF-8" /><constant name="struts.i18n.reload" value="true" /><constant name="struts.configuration.xml.reload" value="false" /><constant name="struts.custom.i18n.resources" value="content/Language" /><constant name="struts.serve.static.browserCache" value="false" /><constant name="struts.action.extension" value="do,action,jhtml,," /><constant name="actionPackages" value="com.frank.action" /> </struts>9.在LoginAction.java中添加调用StudentService@Resourceprivate StudentService studentService;测试Student s = studentService.findById(1);System.out.println(s.getName());10.success.jsp中添加<hr /> ${password}11.启动tomcat,地址栏输入http://localhost:8088/farsighted/点击submit效果如下包结构如下12.测试完成.。

JAVA代码注释规范

JAVA代码注释规范目录JA V A代码注释规范 (1)注释的原则 (1)注释的简洁 (1)注释的一致性 (1)注释的位置 (2)注释的数量 (2)删除无用注释 (2)复杂的注释 (2)多余的注释 (2)必加的注释 (3)JA V A注释技巧 (3)JA V A注释具体实现 (4)源文件注释 (4)类（模块）注释： (5)接口注释： (5)构造函数注释： (6)方法注释： (6)方法内部注释： (7)全局变量注释： (7)局部（中间）变量注释： (7)常量 (7)p.s. 注释使用统一的注释文件 (8)注释的原则注释形式统一在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。

如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。

注释的简洁内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。

注释的一致性在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。

另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。

通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。

修改代码的同时修改相应的注释，以保证代码与注释的同步。

注释的位置保证注释与其描述的代码相邻，即注释的就近原则。

对代码的注释应放在其上方相邻或右方的位置，不可放在下方。

避免在代码行的末尾添加注释；行尾注释使代码更难阅读。

不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。

注释的数量注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。

注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。

不要被动的为写注释而写注释。

删除无用注释在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。

关于MyEclipse代码提示设置包括html和jsp的代码

关于MyEclipse代码提示设置包括html和jsp的代码(一)普通代码提示1.打开MyEclipse，然后“window”→“Preferences”2.选择“java”，展开，“Editor”，选择“ContentAssist”。

3.选择“ContentAssist”，然后看到右边，右边的“Auto-Activation”下面的“AutoActivationtriggersforjava”这个选项。

其实就是指触发代码提示的就是“.”这个符号.4.“AutoActivationtriggersforjava”这个选项，在“.”后加abc 字母，方便后面的查找修改。

然后“apply”，点击“OK”。

5.然后，任意选择个项目“File”→“Export”，在*出的窗口中选择“Perferences”，点击“下一步”。

6.选择导出文件路径，本人导出到桌面，输入“test”作为文件名，点击“保存”。

7.在桌面找到刚在保存的文件“test.epf”,右键选择“用记事本打开”。

8.可以看到很多配置MyEclipse的信息9.按“ctrl+F”快捷键，输入“.abc”，点击“查找下一个”。

10.查找到“.abc”的配置信息.11.把“.abc”改成“.abcdefghijklmnopqrstuvwxyz(,”，保存，关闭“test.epf”。

12.回到MyEclipse界面，“File”→“Import”，在*出的窗口中选择“Perferences”，点击“下一步”，选择刚在已经修改的“test.epf”文件，点击“打开”，点击“Finish”。

该步骤和上面的导出步骤类似。

(二)9.0以后版本的MyEclipse对html和jsp的代码提示1、File-->Export-->General-->Preferences点击下一步，将这个配置文件导出到桌面上，和（一）中的5,6一样2、在桌面上使用文本编辑器打开此文件，在里面添加如下一行内容后保存/instance/org.eclipse.wst.ui/autoProposeCode=<=abcdefghijkl mnopqrstuvwxyz:3、然后将此配置文件导入，File-->Import-->General-->Preferences，就是第一步的逆*作。

java中代码的注释和快捷键

java中代码的注释和快捷键添加必要的注释，对一个有责任心、有道德模范的前端必须具备的好习惯，可以大大提高代码的可维护性、可读性。

java代码注释快捷键：ctrl+shift+/首先熟悉一下html、css、js的注释的写法：1、HTML注释语法：2、css注释语法/* 注释内容*//* ----------文字样式开始---------- */3、javaScript注释//注释内容/*注释内容*/接下来是对注释在这几种代码中使用的位置，如何写注释进行总结一下。

（根据个人的习惯可能不一样）1、html注释使用的位置：1）一般会使用在一些主要节点标签结束的后边，如：<div class="wrap"><div class="main">...</div> <div>2）使用在一些循环的结束的后边，如：<ul class="list"><li>111111</li><li>222222</li><li>333333</li> </ul>2、css注释一般会使用在定义某个模块样式的上边，说明这段样式是作用于哪段模块，如：/*通用- 评论*/.comment{...}/*相册*/.photo{...}/*分享*/.share{...}/*投票*/.vote{...}3、javascript注释一般将注释添加在某段功能函数的上边，说明函数的功能、作者、作者信息、修改时间。

//================================================= =======// 截断字符// steepvi// rtx:*******// 2010-10-14//================================================= =======最后，注释也是字符也是会有流量产生。

JAVA编码规范

第二章重要规范
（ 6 ）服务端，对关键交易请求要素进行日志输出，交易处理完成后输出处理结果；（ 7 ）和外部系统交互，可将日志输出详细些，日志中尽量包括：请求地址、内容、http响应码等状态信息、外部系统响应内容等信息；（ 8 ）数据库操作，捕获SQLException并对异常进行输出，可增加数据库操作错误排查；（ 9 ）捕获异常后要对异常信息输出ERROR级别的日志，输出示例： logger.error(“XXX操作异常：”+e.getMassage(),e); （ 10 ） ERROR级别日志输出一般原则：对于由于系统原因造成业务处理失败的事件，需要记录错误日志。非系统原因的业务处理失败，不应该记录错误日志（推荐使用warn级别），避免错误日志过大，影响紧急情况下的故障分析和诊断；
第三章命名规范
3、1包命名规则 java开发中产生的包分为两类，一类是与各业务系统相关的包；另一类是与业务系统无关的、可公用的包。规则：
包名应全部是小写字母; 包名中不能出现下划线和其他特殊字符; 第一个字母不能是数字。
示例：
与业务系统相关的包命名格式为：com. lianpay.<projectname>.<modulename>
其中：<projectname>为项目英文简称或缩写； <modulename>为模块英文名称或简称，如果无细分模块的话可省略模块名。
与业务系统无关的、可公用的包：com. lianpay.share.<modulename>//所有项目通用
第三章命名规范
3.2类接口命名规则规则：
类的名称应使用名词；类和接口首字母必须大写，每个单词的首字母应大写（骆驼法则）；接口名称应以大写I开始，接口实现类以Impl结尾。

eclipse的配置

Eclipse 配置第1章快捷键的配置（加快开发过程中代码编写）MyEclipse（Eclipse）常用快捷键预览:快捷键组合作用Ctrl+1快速修复(最经典的快捷键,就不用多说了)Ctrl+D 删除当前行Ctrl+Q 定位到最后编辑的地方Ctrl+L 定位在某行(对于程序超过100的人就有福音了)Ctrl+M 最大化当前的Edit或View (再按则反之)Ctrl+/ 注释当前行,再按则取消注释Ctrl+O 快速显示OutLineCtrl+T 快速显示当前类的继承结构Ctrl + F11 快速执行程序Ctrl+Shift+P 定位到对于的匹配符(譬如{}) (从前面定位后面时,光标要在匹配符里面,后面到前面,则反之)Ctrl+Shift+R 全局搜索文件(查找工程内的文件)重构(注:一般重构的快捷键都是Alt+Shift开头的了)Alt+Shift+R 重命名(是我自己最爱用的一个了,尤其是变量和类的Rename)变量名全局更改(对于变量的引用很有用)Alt+Shift+M 抽取方法(这是重构里面最常用的方法之一了,尤其是对一大堆泥团代码有用)Alt+Shift+C 修改函数结构(比较实用,有N个函数调用了这个方法,修改一次搞定)Alt+Shift+L 抽取本地变量( 可以直接把一些魔法数字和字符串抽取成一个变量,尤其是多处调用的时候)Alt+Shift+F 把Class中的local变量变为field变量(比较实用的功能)Alt+Shift+I 合并变量(可能这样说有点不妥Inline)Alt+Shift+V 移动函数和变量(不怎么常用)Alt+Shift+Z 重构的后悔药(Undo)Alt+Shift+S 弹出资源代码(生成set/get方法的时候可以使用)Alt+Shift+J 增加预定义注释F3 跳转到类、变量的声明Ctrl+Alt+↓复制当前行到下一行(复制增加)Ctrl+Alt+↑复制当前行到上一行(复制增加)ALT+↑当前行和上面一行交互位置(同上)Alt+↓当前行和下面一行交互位置(特别实用,可以省去先剪切,再粘贴了)Shift+Enter 在当前行的下一行插入空行(这时鼠标可以在当前行的任一位置,不一定是最后)第2章设置代码自动提示。

1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。

现就每一个元素逐一介绍：
文件(Files)注释标签：
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author chenguang
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签（类的注释）：
/**
* 类功能说明
* 类修改者修改日期
* 修改说明
* <p>Title: ${file_name}</p>
* <p>Description:清大海辉科技开发平台</p>
* <p>Copyright: Copyright (c) 2006</p>
* <p>Company:北京清大海辉科技有限公司</p>
* @author ${user}
* @date ${date} ${time}
* @version V1.0
*/
字段(Fields)注释标签：
/**
* @Fields ${field} : ${todo}
*/
构造函数标签：
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签：
/**
* 函数功能说明
* ${user} ${date}
* 修改者名字修改日期
* 修改内容
* @param ${tags}
* @return ${return_type}
* @throws
*/
getter方法标签：
/**
* @return ${bare_field_name}
*/
setter方法标签：
/**
* @param ${param} ${bare_field_name}
*/
加注释快捷键：选中你要加注释的方法或类，按Alt + shift + J。