2. 班级: 班级的目的，即班级完成的功能，以及班级的创建时间和作者姓名；当多个人一次编辑或修改同一个班级时，

作者姓名中应出现多个姓名；

3. 接口: 在满足类注释的基础上，接口注释应包含设置接口的目的，应如何使用接口以及不应该使用接口.

在清除接口注释的前提下，可以不注释相应的实现类；

4. 方法说明: 对于设置(设置方法)和获取(获取方法)成员的方法，在解释了成员变量后，

无需评论；需要使用普通的成员方法来解释完成的功能，参数的含义以及返回值是什么；创建其他方法

必须清楚地注明时间，以便为以后的维护和阅读提供有价值的线索；

5. 方法内部注释: 控制结构，代码做什么以及为什么执行，处理顺序等，尤其是复杂的逻辑处理部分，

尽可能给出详细的注释；

6. 参数: 参数含义，以及任何其他约束或先决条件；

7. 属性: 字段描述；

8. 局部(中间)变量: 如果没有特殊含义，则不予评论；

3. 注释格式

按照项目指定的统一注释格式jsp注释的格式，通常情况下，它将以codetemplates.xml的格式导入IDE(Eclipse)

或使用默认的Eclipse；

四个代码格式规范

遵循项目指定的统一代码格式，通常使用IDE(Eclipse)随附的默认代码格式来格式化代码；

1，单行(单行)-简短说明: ///...

单行注释: 代码中的单行注释. 最好在注释前有一个空白行，并在其后加上与代码相同的缩进级别. 如果一行不能完成，则应使用块注释.

评论格式:

行标题注释: 在代码行的开头进行注释. 主要是使代码行毫无意义.

评论格式: //评论内容

在行尾注释: 尾随-在代码行末尾的简短注释. 通常在代码行后8个(至少4个)空格，并且所有注释必须对齐.

评论格式: 代码+ 8个(至少4个)空格+ //评论内容

2. 阻止-阻止评论:

注释几行，通常用于提供文件，方法，数据结构等的含义和目的的描述，或算法的描述. 通常位于文件或方法的前面，它具有指导作用，也可以根据需要放置在合适的位置. 此域注释不会出现在HTML报告中. 注释格式通常写为:

3. 文件注释:

注释几行并写入javadoc文档. 每个文档注释都将放置在注释定界符中

其中，注释文档将用于生成HTML格式的代码报告，因此注释文本

The

文件必须在定义类，字段，构造函数，方法和字段之前编写. 注释文档由两部分组成: 描述和块标记. 批注文档的格式如下:

公共无效doGet(HttpServletRequest请求，HttpServletResponse响应)

引发ServletException，IOException {

doPost(请求，响应);

}

前两行的说明. 说明完成后，块符号以@符号开头. 更多文档说明

有关Shihe javadoc的详细信息，请参见javadoc主页:

4. javadoc注释标记语法

@author对类的描述表示开发该模块的作者

@version对类的描述表示该类模块的版本

通过@see参考转向(即相关主题)来描述类，属性和方法

@param对方法的描述方法中对参数的描述

@return方法说明该方法返回值的说明

@exception对方法的说明解释该方法可能引发的异常

六，特定于Java注释的实现

1，源文件注释

注释源文件，并且必须在每个源文件的开头包含必要的注释信息，包括: 文件名；文件编号;版本号；作者;创建时间；文件描述，包括此文件的历史修改记录. 中文注释模板:

2. 类(模块)注释:

使用类(模块)注释. 在每个类(模块)的开头，必须包括必要的注释信息，包括: 项目名称；类(模块)号；命名空间该类可以运行的JDK版本；版本号;作者;创建时间；类(模块)的功能描述(如功能，主要算法，内部部件之间的关系，此类与其类之间的关系等)，必要时必须有一些特殊的软硬件要求等说明；此类别(模块)的主要功能或过程列表以及历史记录修改记录.

英语注释模板:

如果模块仅修改少量代码，则每次修改都必须添加以释:

//重写器

//重写日期: 开始1:

// End1:

注释掉原始代码的内容，然后使用以释添加新代码:

//添加人

//添加日期: 开始2:

// End2:

如果模块的输入和输出参数或功能结构有重大修改，则每次修改都必须添加以下内容

评论:

//日志ID:

//描述:

//作者: 修改者的中文名称

//重写日期:

2. 界面说明:

使用接口注释. 在满足类注释的基础上，接口注释应包含对接口用途，应如何使用以及如何不使用接口的描述. 方框标记必须指明作者和版本. 在清除接口注释的前提下，可以不注释相应的实现类.

3. 构造说明:

构造函数注释使用，描述部分指示构造函数的作用，并且不一定有块标记.

评论模板一:

评论模板二:

4. 功能说明:

使用功能注释. 在每个功能或过程之前，必须有必要的注释信息，包括: 功能或过程名称；功能说明;输入，输出和返回值说明；调用关系和被调用关系描述等. 版本号(@version)可能不会出现在函数注释中.

评论模板一:

评论模板二:

5. 方法说明:

采用方法注释. 对于设置(Set方法)和获取(Get方法)成员的方法，在解释了成员变量后，不能添加任何注释；普通成员方法要求解释什么功能完成，参数含义是什么，返回值是什么；此外，必须清楚说明该方法的创建时间，以为将来的维护和阅读提供有价值的线索.

6. 该方法的内部注释:

控制结构，代码的功能以及执行的原因，处理顺序等，尤其是复杂的逻辑处理部分，应尽可能给出详细的注释.

7. 全局变量注释:

必须有更详细的注释，包括其功能，值范围，访问的功能或过程的说明以及访问期间的注意事项.

8. 局部(中间)变量注释:

必须对主要变量进行注释，如果没有特殊含义，可以不加注释.

9. 实际参数/参数说明:

参数含义以及其他任何约束或前提条件.

10. 字段/属性注释: 字段描述，属性描述.

11. 常量: 常量通常具有一定的实际意义，应定义相应的描述.

－－－－－－－－－－－－－－华丽的分隔线－－－－－－－－－－－－－－－－－－－－－－－－－－－－－ －－－－ －－－－－－－－－－－－－－－

与myeclipse相关的评论

1. 自动注释Java文件

Window->首选项－> Java->代码样式->代码模板

文件: 创建新文件时的注释

类型: 凝视的目光

字段: 变量注释

构造函数: 构造函数的注释

方法: 一般方法说明

您可以编辑一些固定格式或变量，在这些格式或变量中，用户默认使用操作系统的名称，可以对其进行硬编码. 日期格式，我想知道如何更改为yyyy-mm-dd

2. 评论JSP文件

Window-> Preference-myeclipse-editors-JSP-JSP模板

3. Java示例中使用的一些快捷方式: sysout

Window-> Preference-java-editor-templates

您可以自己编写一些参数〜例如用户--- zhongjb

五，其他规格

JSP文件命名

完整的英语描述用于解释JSP的功能，包括尽可能生动的动词，首字母小写，

例如: viewMessage.jsp，editUser.jsp等.

六. 项目特定的命名约定

1. 持久层

1，Hibernate映射文件和实体

与表名称完全对应；

例如: Advertisement.hbm.xml，Advertisement.java

2. 数据访问DAO

DAO接口和实现类名称必须完全符合正常的接口和实现类命名规则，最后以“ DAO”结尾

DAO中的数据访问方法必须足够抽象，以描述上的基本CRUD操作；

例如: ICrossAdDAO(接口)，CrossAdDAO(实现类)

3. 各种操作的HQL配置文件

HQL文件的数量原则上等于系统“服务”层中的服务数量，并且HQL文件以服务名称命名；

例如: resource.hbm.xml

2. 服务层

1. 服务接口与实现

服务接口和实现类必须完全符合常规接口和实现类的命名规则；项目定义的服务名称是主体，

全部以“ Serv”结尾

例如: IResourceServ(服务接口)，ResourceServ(接口实现类)

2. 服务接口方法

方法名称是一个动词，大小写混合，第一个单词的首字母小写，然后该单词的首字母大写.

方法名称尽可能地描述了该方法的动作行为.

返回类型是布尔值: 以“ is”或“ has”开头

获取特定数据: get +数据描述名词复数+数据类型；

获取所有数据: get + All +数据描述名词复数+数据类型；

通过XXX获取/查询特定数据: get / query +数据描述名词复数+数据类型+ By +条件；

添加一些数据: 保存/添加+数据描述名词()

更新某些数据: 保存/更新+数据描述名词；

删除某些数据: 删除/删除+数据描述名词；

3. 业务对象

商家名称+ BO

4. 查询参数对象

所有继承Abst *** QuerySpec的查询参数类都满足以下规则:

查询+要查询的数据描述名词+ Spec

作为参数传递时，参数名称必须为: 要查询的数据描述名词+ Spec

例如: QueryProgramSpec

3. MVC层

1jsp注释的格式，动作控制层

动作类名称: 功能模块名称+ Action;

Actoin方法名称尽可能描述页面迁移目标

例如: LoginAction(登录操作)，toWelcome(转到欢迎页面操作方法)

2. 资源文件

系统全局资源文件: globalMessages_ +字符编码类型+ .properties

功能模块内的资源文件: package.properties

4. 春季配置文件

1，与动作相关的配置文件

文件目录: WebRoot / WEB-INF / spring / action /功能模块名称+ _ApplicationContext.xml

2. 服务相关的配置文件

文件目录: WebRoot / WEB-INF / spring / services / Services_ApplicationContext.xml

3. 全局配置文件

文件目录: WebRoot / WEB-INF / spring /项目名称+ _ApplicationContext.xml

5. JSP文件

完整的英文说明JSP

本文来自电脑杂谈，转载请注明本文网址：

http://www.pc-fly.com/a/jisuanjixue/article-269399-1.html