英茂二手车编程规范.doc

《英茂二手车网站》 编 程 规 范 昆明易点网络信息有限公司 2014年08月 目录 前言 3 第一章 总体开发原则 4 第二章 用户界面开发规范 5 一. 界面组织形式 5 二. 整体风格设计 5 三. 动态配置菜单 6 第三章 业务逻辑开发规范 7 一. 会话管理 7 二. 错误处理机制 7 三. 日志处理 10 3.1 系统日志处理 10 3.2 操作日志记录 12 3.3 系统日志扑捉及操作日志记录示例： 12 四. 数据库访问控制控制 14 五. 权限管理 15 1. 菜单管理 15 2. 菜单功能权限管理 15 3. 菜单-功能-权限-用户关系 16 六. 一般开发规范 17 1. 开发工具、系统软件的规范 17 2. 目录划分 17 2.1. 根目录 17 2.2. 实际文件目录 17 第四章 通信规范 18 一．XML规范 18 1. 使用GB2312的字符集 18 2. 元素名称 19 3. 所有的元素都必须正确关闭 19 4. 元素之间不能交叉 19 5. 所有的属性值都必须使用引号 19 6. 注释 19 二．WEB服务规范 20 第五章 安全开发规范 25 一. 统一认证开发规范 25 第六章 附录 26 1. C#程序开发规范 26 1.1. 文件的命名 26 1.2. 文件的组织 26 1.3. 缩进（indentation） 27 1.4. 注释 28 1.5. 声明 29 1.6. 语句 31 1.7. 空格 35 1.8. 命名规则 36 1.9. 程序规则 37 前言 随着B/S应用的不断增多，规范化的要求就越来越迫切。在总结现有B/S应用在设计和开发等方面积累的经验，并参照一些关于B/S应用的规范化的事实标准，整理了B/S应用系统的规范。为了整体说明B/S应用系统的规范，必须制定开发规范。 设计规范从系统设计的角度分析问题，从用户界面设计、业务逻辑设计、存储设计、通信设计、安全设计和外部连接设计六个方面说明B/S应用系统设计时应该要遵循的原则和基本方法，旨在对应用系统的概要设计和部分的详细设计工作提供规范化的指导。开发规范从系统开发的角度分析问题，分析了开发用户界面、业务逻辑、数据存储、与内部系统的通信、安全和外部连接等六个方面的具体开发时所要遵循的方法、规则和具体要求等等，旨在对开发人员的具体开发工作提供规范化的指导。 制订规范的目的是用规范指导应用系统的设计和开发，保证应用系统的稳定和高效率。但是，如果规范仅仅是一些文字描述或文档，那么存在两方面的问题，一方面是不同的人对规范的理解不可能完全一致，因此实际工作中可能会偏离规范；另外，在按照规范进行实际的设计和开发时，如果大家是直接面对底层的技术，即使是按照规范进行开发，但是不同的人开发的代码在稳定性和效率方面有区别。因此，单纯的文字性的规范的实际指导作用有限。 本文主要对我公司B/S应用系统在开发过程中必须遵循的开发原则进行规范，从界面、业务逻辑处理、存储、连接、安全、外联等方面介绍和描述。  总体开发原则 B/S应用开发应该至少遵循如下原则： 完全按照设计文档进行开发； 程序代码应该具有充分的可重用性和可继承性。 编程规范编写的目的是成为本项目组开发人员的开发参考手册，由于项目架构平台暂时还处于设计和评测阶段，所以目前版本的开发规范主要从开发应该遵循的基本原则出发，进行相关描述，同时对一些已经明确的内容也进行了详细的展开。在系统架构平台完成以后，会再对开发规范进行进一步完善和调整，最终形成以业务处理三层架构平台为基础的开发人员实用开发手册。 以下描述的内容中的大部分会整合到项目开发好的系统框架中。  用户界面开发规范 B/S应用系统用户界面要求内容明确、清晰，使用户明了自己所处的位置，并能快速找到自己需要的内容。 内容安排上，将最重要的、最想要用户知道的信息，放在最显眼的位置。操作导航区必须处于页面的同一位置，不得随意摆放,按照系统现有的框架来布局和实现。 界面组织形式 B/S应用系统的用户界面采用框架（frame）的处理方式。如下图所示。用户界面设计是面向1024×768的显示分辨率来进行。 整体风格设计 整体风格设计此处是指整个B/S系统中的字体、色彩、图像、文字排版等。系统采用CSS（Cascading Style Sheets，即统一风格样式表）来保证整个系统的风格统一。相关字体、文字大小、段落格式、字体链接用色等均在外部样式表文件中进行定义，再由系统中各界面分别调用，调用方式：<link rel="stylesheet" type="text/css" href="<样式表路径>style.css">。 在实施过程中，采用W3C发布的CSS1标准，对外部样式表进行修改中，也须遵从此标准以保证兼容。 字体： 系统选用的字