文档介绍：探索信息科技有限公司编程规范2013年10月总述 3适用范围 3规范说明 3基本原则 3命名原则 3布局原则 3文件布局 4程序目录 4数据库设计 5命名方法 5SQL语句 6数据字典 6数据库连接 6编程规范 7文件命名 7程序布局 7类的定义 9变量定义 9常量说明 11函数声明 11代码注释 12缩进与换行 12程序文档 12总述为加强软件的质量管理,使软件开发形成统一的编程风格,特制定编稈规范,要求软件开发人员遵照执行。适用范围公司所有软件设计人员和软件开发人员。规范说明本文拟订的规范中,凡C/S结构的软件开发规范均以C语言和Java语言为基础,凡B/S结构的软件开发规范均以JSP语言为基础;对于其他语言,可以针对各自的特性进行翻译,比如由于采用的注释符号不同,应根据实际情况进行转换。本文拟订的规范中,分为必须遵守和建议遵守两种类型,凡出现“建议”字样者即为建议遵守,否则为必须遵守。本文拟定的规范,旨在提供纲领性的说明,对于实际开发中遇到的特殊情况,可以遵照相关原则进行细化。基本原则命名原则前台语言编程统一采用匈牙利命名法,后台数据库设计统一采用驼峰命名法。根据命名对彖的不同,可以进行适当的简化,但含义必须直观。建议名称尽量优先使用含义明确的英文单词组合,如果英文单词无法简洁地表达含义,可以使用屮文拼音缩写,对这种情况,必须在数据字典中明确说明。布局原则统一采用面向对象的实现模式,即公共的和私有的进行明确的划分,包括程序文件的布局和程序代码的布局。文件布局程序目录程序目录是源程序的集中存放地和发布源。对于C/S结构的软件开发,主要包扌舌三个子目录,每个子目录可以有不同数量的子目录。为了使用方便,程序目录的子目录要求使用英文。Source源程序目录,可以简写为Src,存放项目的所有源程序。Output输出目录,存放编译后的可执行文件,动态链接库,Java类/包等。Resource资源目录,可以简写为Res,程序所使用到的各种图片资源、文字材料等。对于B/S结构的软件开发,按照如下原则建立目录:不同站点不同FI录,不同模块不同FI录,站点与站点平级,模块与模块平级;不同站点间的公用FI录与站点FI录平级,不同模块间的公用FI录与模块FI录平级;模块目录下原则上只放JSP文件和HTM文件,样式表和Ijs文件放在公用目录中;模块目录下不提倡放置测试文件和备份文件,测试文件和备份文件分目录存放;目录名称是小写,如果存在多个单词,则第一个单词后面的单词首个字母为大写,以示区分。Jsp|——common|……images|……sysManagerI | common| | report| | userManager|……webClient| | common| | affix| | publnfo|——mailManager|—Web-inf| | classes| | JavaBean包ASP|……common|……images|……monI |——affix| | userManager|……mailManager| | common| | userManager| | report|——webClient|……componentI卜••命名,包中,下一层为公司标识,统一为ejoysoft,第三层为具体功能类型(功能模块),在功能类型中,包含属于同种功能类型或者同一模块中的类代码。.,为邮件包。组件的组件命名方式,同一模块的功能存放在同一个dll中,命名方式按照文件命名方法进行命名。数据库设计这一部分主要由设计人员完成。命名方法数据库名、表名、视图名、存储过程名、字段名等均使用小写字母,并采用驼峰命名法,特殊的单词或者是有特殊含义的英文单词可以用大写,如:ID(编号,唯一标识),PC(邮政编码)等等。各种名称由若干有意义的单词拼写而成,如果单词过长,可以使用缩写,但要直观;如存在多个单词,则第一个单词后续的单词首字母要大写,用以区分每个单词;建议少用汉语拼音缩写的组合方式,如果使用的话,必须在数据字典中准确描述。命名的格式为:类型标志 名称以下是类型标志对照表:类型标志类型说明tTABLE表VVIEW视图PPROCEDURE存储过程idxINDEX索引以下是一些例子:databasename,t_tablename,v_viewname,p_procedurename,fieldname。对于数据库名和字段名,类型标志可以省略。SQL语句SQL语句的关键字(女口SELECT、FROM、GROUPBY等)要使用大写字母。注:本条设计人员和开发人员均应遵守。数据字典凡涉及到数据库设计的内容,都要填写完整的数据字典,具体包括以下内容:表、视图、存储过程的设计意图,表存储的是什么样的数据、视图的功能、存储过程的