HT-COD-G-03-Java及数据库编码规范.docVIP

华拓金服质量管理体系 编码规范 文件状态： 公 司 　 保 密 等 级 对内公开 【 】草 稿【 】修 改 稿【√】正式发布 作 者 　 最后完成日期 　 审核人员 　 最后审核日期 　 版本 V1.0 修改记录 日期 版本 作者/修改者 修订类型 描述 目 录 1 前言 1 1.1 目的 1 1.2 范围 1 1.3 内容提要 1 2 JAVA编码规范 1 2.1 注释规范 1 2.1.1 源文件注释【一般】 1 2.1.2 类注释【严重】 2 2.1.3 接口注释【严重】 3 2.1.4 构造函数注释【一般】 3 2.1.5 函数注释【严重】 3 2.1.6 函数内部注释【严重】 4 2.1.7 全局变量注释【严重】 7 2.2 命名规范 7 2.2.1 项目包命名【一般】 7 2.2.2 包名【一般】 7 2.2.3 类名【一般】 7 2.2.4 函数（方法）名【一般】 8 2.2.5 属性（变量）名【一般】 8 2.2.6 常量名【一般】 8 2.3 编码规范 8 3 数据库编码规范 10 3.1 命名规范【一般】 10 3.2 设计规范 11 3.3 SQL编码规范 12 3.4 过程/函数编码规范 13 4 WEB编码规范 19 4.1 HTML编码规范 20 4.2 JavaScript编码规范 21 4.3 CSS编码规范 22 前言 目的范围 内容提要… … */，在源文件头部包含必要的信息，如文件名、版本号、作者、创建时间、修改信息等，模板如下： /** * FileName: ${file_name} br * Description: 描述信息 ${todo} br * Create By: ${user} br * Create Date: ${date} ${time} br * Modified By: br * Modified Date: br * Version: 1.0 br */ 各注释含义如下： FileName 文件名称 Description 文件描述 Create By 创建人 Create Date 创建日期 Modified By 最后修改人 Modified Date 最后修改日期 Version 版本号 类注释【严重】 类的注释采用/** … … */，在类的头部需要包含必要的信息，如类的描述（功能、主要算法、调用关系等）、作者、创建时间、修改信息、版本号等，模板如下： /** * ClassName: ${type_name} br * Description: 描述信息 ${todo} br * Create By: ${user} br * Create Date: ${date} ${time} br * Modified By: br * Modified Date: br * Modified Content: br * Version: 1.0 br */ 各注释含义如下： ClassName 类名称 Description 类的描述（功能、算法以及重要的调用关系等） Create By 创建人 Create Date 创建日期 Modified By 修改人 Modified Date 修改日期 Modified Content 修改内容 Version 版本号 对于重大的修改需要填写修改人、修改日期、修改内容信息，此部分可包含多个；对于细微的修改可以在代码中进行登记，不要求在此处进行登记。 接口注释【严重】 接口的注释采用/** … … */的方式在接口的头部添加，在满足类注释的前提下需要对接口的目的进行描述，同时接口中的函数（方法）必须按照函数注释的规范进行编写，在接口注释清楚的前提下，其实现类注释的描述部分仅需要描述针对接口的哪方面实现即可，无需详细描述，其实现函数（方法）也可省略函数注释。 构造函数注释【一般】 默认构造函数无需填写注释，当构造函数带有参数时需要填写构造函数注释，构造函数注释采用/** … … */的方式在函数头部添加，主要进行参数描述，模板如下： /** * @param 变量名称 变量描述 ${todo} br */ 根据实际情况对变量进行描述即可。 函数注释【严重】 函数注释采用… … */，在每个函数或者过程的前面要有必要的注释信息/** * Description: 描述信息 ${todo} br * Create By: ${user} br * Create Data: ${date} ${time} * * @param 变量名称 变量描述 ${todo}