程序设计和编码规范.docVIP

目 录 1 总体要求 3 2 命名规范 3 2.1 概述 3 2.2 文件命名规范 3 2.3 函数命名规范 3 2.4 变量命名规范 3 2.5 常量命名规范 4 2.6 数据库表命名规范 4 3 注释规范 4 3.1 概述 4 3.2 代码文件的注释 4 3.3 数据对象的注释 5 4 程序书写格式 5 4.1 空格、空行与缩进 5 4.2 SQL语句书写规范 5 4.3 其它规范 6 4.4 详细和编辑页的权限判断顺序 6 5 编程准则 6 5.1 变量使用规范 6 5.2 数据库操作规范 6 5.3 对象使用规范 6 5.4 模块设计原则 6 5.5 数据库表设计原则 7 6 界面设计规范 7 6.1 基本原则 7 6.2 版面样式 7 6.3 保持页面的一致性 7 6.4 文字表述 7 6.5 B/S构架适用原则 8 7 主要名词/动词汉英对照表 8 8 缩写标准 9 8.1 常用缩写 9 8.2 前缀缩写 9 8.2.1 类型前缀 9 8.2.2 控件前缀 10 程序设计和编码规范 总体要求 必须严格执行本规范以确保源代码的可读性可维护性CustomerEdit.aspx。 文件和文件夹的名称应该精确地说明它们的用途。 函数命名规范 函数名和方法名以动词开始，首字母大写，如SaveFileLog。 在命名函数时包括返回值的说明，如GetFileName。 类名和属性名以名词开始，不加前缀，首字母大写，如EmployeeName。 在不同的类中的属性，如果它们有相同的作用，则必须使用同样的名称。 变量命名规范 变量可以加前缀，前缀使用2至4个字母，全部小写；public变量不要加前缀。 避免与数据字典中的数据元素名相同。 避免与函数名、方法名、类名和属性名相同。 在同一个程序文件中，避免使变量名为另一个变量名的一部分。 常量命名规范 常量所有字母都应该大写，单词之间可以用下划线连接。 数据库表命名规范 库表名称必须使用前缀T_，例如T_CustomerInfo。 视图名称必须使用前缀V_，例如V_CustomerInfo。 存储过程名称必须使用前缀P_，例如P_GetAllCustomer。 根据项目的不同，前缀有所不同，例如Tb_、Pc_等，在同一个项目同中，前缀必须一致。 字段名称使用小写，每个单词之间加下划线，例如：customer_name。 注释规范 概述 注释必须使用中文及中文的标点符号。 每行注释的最大长度为100个字符。 将注释与注释分隔符用一个空格分开。 不允许给注释加外框。 编码的同时书写注释。 重要变量必须有注释。 变量注释和变量在同一行，所有注释必须对齐。 典型算法必须有注释。 在循环和逻辑分支的地方必须写上注释。 程序段或语句的注释在程序段或语句的上一行。 在代码交付之前，必须删掉临时的或无关的注释。 被注释的代码必须加上必要的注释，以说明这些代码被注释的原因。 对控件属性的赋值语句本身不需要注释，只有所赋值来源比较复杂时才需要特别注释说明。 代码文件的注释 代码文件的头部必须有概述注释信息。 代码文件的概述注释，包括以下内容： 属性（主要功能） 创建人 创建时间 每次有重要更新时，必须在文件头增加更新历史，包括以下内容： 更新人 更新时间 更新说明 泰捷控件库中的公用控件和公用函数的方法或属性等必须添加必要的智能提示。 数据对象的注释 每个数据对象包括表、字段和存储过程等，都必须作相关的注释说明。 触发器和存储过程注释信息必须包括以下内容： 功能 作者 日期 更新历史 程序书写格式 空格、空行与缩进 在操作符的前后必须使用空格。 在分隔数组下标和函数参数的逗号后面必须添上空格。 一个程序段上下必须使用空行。 变量定义部分与程序语句之间必须使用空行。 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab键为4个空格字符。 使用编程工具的智能排版实现以下程序缩进： function {} void {} if {} else {} for {} switch {} foreach {} while {} try {} catch {} SQL语句书写规范 写SQL语句时，关键字使用大写（如SELECT、WHERE等）。 把每个SQL子语句分开放在不同的行中。 其它规范 不允许使用纯粹的不带语意的数字或字符串。比如：for (int i = 1; i 7; i++)； 而应该使用定义过的常量，比如：for (int i = 1; i NUM_DAYS_IN_WEEK; i++)。 主要变量放在函数的最前面，并分类排列。 详细和编辑页的权限判断顺序 首先判断是否有浏览该页的权限； 然后判断记录是否存在； 最后判断是否有编辑和删除权限。 编程准则 变量使用规范 不允许随意定义