探索培训班编程规范.docxVIP

探索信息科技有限公司 编程规范 2013年10月 TOC \o 1-5 \h \z HYPERLINK \l bookmark0 \o Current Document 总述 3 HYPERLINK \l bookmark2 \o Current Document 适用范围 3 HYPERLINK \l bookmark4 \o Current Document 规范说明 3 HYPERLINK \l bookmark6 \o Current Document 基本原则 3 HYPERLINK \l bookmark8 \o Current Document 命名原则 3 HYPERLINK \l bookmark10 \o Current Document 布局原则 3 HYPERLINK \l bookmark12 \o Current Document 文件布局 4 HYPERLINK \l bookmark14 \o Current Document 程序目录 4 HYPERLINK \l bookmark22 \o Current Document 数据库设计 5 HYPERLINK \l bookmark24 \o Current Document 命名方法 5 HYPERLINK \l bookmark26 \o Current Document SQL语句 6 HYPERLINK \l bookmark28 \o Current Document 数据字典 6 HYPERLINK \l bookmark30 \o Current Document 数据库连接 6 HYPERLINK \l bookmark32 \o Current Document 编程规范 7 HYPERLINK \l bookmark34 \o Current Document 文件命名 7 HYPERLINK \l bookmark36 \o Current Document 程序布局 7 HYPERLINK \l bookmark38 \o Current Document 类的定义 9 HYPERLINK \l bookmark40 \o Current Document 变量定义 9 HYPERLINK \l bookmark42 \o Current Document 常量说明 11 HYPERLINK \l bookmark44 \o Current Document 函数声明 11 HYPERLINK \l bookmark46 \o Current Document 代码注释 12 HYPERLINK \l bookmark48 \o Current Document 缩进与换行 12 程序文档 12 总述 为加强软件的质量管理，使软件开发形成统一的编程风格，特制定编稈规范，要求软件 开发人员遵照执行。 适用范围 公司所有软件设计人员和软件开发人员。 规范说明 本文拟订的规范中，凡C/S结构的软件开发规范均以C语言和Java语言为基础, 凡B/S结构的软件开发规范均以JSP语言为基础；对于其他语言，可以针对各自 的特性进行翻译，比如由于采用的注释符号不同，应根据实际情况进行转换。 本文拟订的规范中，分为必须遵守和建议遵守两种类型，凡出现“建议”字样者 即为建议遵守，否则为必须遵守。 本文拟定的规范，旨在提供纲领性的说明，对于实际开发中遇到的特殊情况，可 以遵照相关原则进行细化。 基本原则 命名原则 前台语言编程统一采用匈牙利命名法，后台数据库设计统一采用驼峰命名法。根据命名 对彖的不同，可以进行适当的简化，但含义必须直观。建议名称尽量优先使用含义明确的英 文单词组合，如果英文单词无法简洁地表达含义，可以使用屮文拼音缩写，对这种情况，必 须在数据字典中明确说明。 布局原则 统一采用面向对象的实现模式，即公共的和私有的进行明确的划分，包括程序文件的布 局和程序代码的布局。 文件布局 程序目录 程序目录是源程序的集中存放地和发布源。 对于C/S结构的软件开发，主要包扌舌三个子目录，每个子目录可以有不同数量的子目 录。为了使用方便，程序目录的子目录要求使用英文。 Source 源程序目录，可以简写为Src,存放项目的所有源程序。 Output 输出目录，存放编译后的可执行文件，动态链接库，Java类/包等。 Resource 资源目录，可以简写为Res,程序所使用到的各种图片资源、文字材料等。 对于B/S结构的软件开发，按照如下原则建立目录： 不同站点不同FI录，不同模块不同FI录，站点与站点平级，模块与模块平级； 不同站点间的公用FI录与站点FI录平级，不同模块间的公用FI录与模块F