程序设计和编码规范.doc

第 1 页 共 10 页 程序设计和编码规范 目目 录录 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.2SQL 语句书写规范.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.5B/S 构架适用原则.8 第 2 页 共 10 页 程序设计和编码规范 7主要名词/动词汉英对照表.8 8缩写标准.9 8.1常用缩写 9 8.2前缀缩写 9 8.2.1类型前缀 .9 8.2.2控件前缀 .10 第 3 页 共 10 页 程序设计和编码规范 程序设计和编码规范程序设计和编码规范 1 1 总体要求总体要求 1、 必须严格执行本规范以确保源代码的可读性及可维护性。 2、 所有的程序文件都必须有注释文字，并严格按照本规范中的“注释规范”书写。 3、 必须使用泰捷控件库提供的公用控件和公用函数。 4、 同一个项目中必须使用相同的开发语言。 5、 保持每个程序文件的程序书写格式一致，功能相似的页面控件引用顺序也应该 是一致的。 2 2 命名规范命名规范 2.12.1 概述概述 1、 必须使用美国英语标准英文单词，不允许使用中文拼音（中文地名和人名除外） 。 2、 选择使用频率较高的常用词。 3、 如果有名词，必须使用单数形式。 4、 使用大小写混合格式，将连接的几个单词首字母大写。 5、 必须在 3 至 30 个字母以内,临时的循环变量可以使用一个字母，如 i，j，k 等。 6、 如果使用缩写，必须使用本规范附录的缩写范例。 2.22.2 文件命名规范文件命名规范 1、 文件命名采用主谓结构，首字母大写，如 CustomerEdit.aspx。 2、 文件和文件夹的名称应该精确地说明它们的用途。 2.32.3 函数命名规范函数命名规范 1、 函数名和方法名以动词开始，首字母大写，如 SaveFileLog。 2、 在命名函数时包括返回值的说明，如 GetFileName。 3、 类名和属性名以名词开始，不加前缀，首字母大写，如 EmployeeName。 4、 在不同的类中的属性，如果它们有相同的作用，则必须使用同样的名称。 2.42.4 变量命名规范变量命名规范 1、 变量可以加前缀，前缀使用 2 至 4 个字母，全部小写；public 变量不要加前缀。 第 4 页 共 10 页 程序设计和编码规范 2、 避免与数据字典中的数据元素名相同。 3、 避免与函数名、方法名、类名和属性名相同。 4、 在同一个程序文件中，避免使变量名为另一个变量名的一部分。 2.52.5 常量命名规范常量命名规范 1、 常量所有字母都应该大写，单词之间可以用下划线连接。 2.62.6 数据库表命名规范数据库表命名规范 1、 库表名称必须使用前缀 T_，例如 T_CustomerInfo。 2、 视图名称必须使用前缀 V_，例如 V_CustomerInfo。 3、 存储过程名称必须使用前缀 P_，例如 P_GetAllCustomer。 4、 根据项目的不同，前缀有所不同，例如 Tb_、Pc_等，在同一个项目同中，前缀 必须一致。 5、 字段名称使用小写，每个单词之间加下划线，例如：customer_name。 3 3 注释规范注释规范 3.13.1 概述概述 1、 注释必须使用中文及中文的标点符号。 2、 每行注释的最大长度为 100 个字符。 3、 将注释与注释分隔符用一个空格分开。 4、 不允许给注释加外框。 5、 编码的同时书写注释。 6、 重要变量必须有注释。 7、 变量注释和变量在同一行，所有注释必须对齐。 8、 典型算法必须有注释。 9、 在循环和逻辑分支的地方必须写上注释。 10、 程序段或语句的注释在程序段或语句的上一行。 11、 在代码交付之前，必须删掉临时的或无关的注释。 12、 被注释的代码必须加上必要的注释，以说明这些代码被注释的原因。 13、 对控件属性的赋值语句本身不需要注释，只有所赋值来源比较复杂时才需要特 别注释说明。 3.23.2 代码文件的注释代码文件的注释 1、 代码文件的头部必须有概述注释信息。 第 5 页 共 10 页 程序设计和编码规范 2、 代码文件的概述注释，包括以下内容： a) 属性（主要功能） b) 创建人 c) 创建时间 每次有重要更新时，必须在文件头增加更新历史，包括以下内容： a) 更新人 b) 更新时间 c) 更新说明 3、 泰捷控件库中的公用控件和公用函数的方法或属性等必须添加必要的智能提示。 3.33.3 数据对象的注释数据对象的注释 1、 每个数据对象包括表、字段和存储过程等，都必须作相关的注释说明。 2、 触发器和存储过程注释信息必须包括以下内容： a) 功能 b) 作者 c) 日期 d) 更新历史 4 4 程序书写格式程序书写格式 4.14.1 空格、空行与缩进空格、空行与缩进 1、 在操作符的前后必须使用空格。 2、 在分隔数组下标和函数参数的逗号后面必须添上空格。 3、 一个程序段上下必须使用空行。 4、 变量定义部分与程序语句之间必须使用空行。 5、 利用缩进来显示程序的逻辑结构，缩进量一致并以 Tab 键为单位，定义 Tab 键 为 4 个空格字符。 6、 使用编程工具的智能排版实现以下程序缩进： 1) function 2) void 3) if else 4) for 5) switch 6) foreach 第 6 页 共 10 页 程序设计和编码规范 7) while 8) try catch 4.24.2 SQLSQL 语句书写规范语句书写规范 1、 写 SQL 语句时，关键字使用大写（如 SELECT、WHERE 等） 。 2、 把每个 SQL 子语句分开放在不同的行中。 4.34.3 其它规范其它规范 1、 不允许使用纯粹的不带语意的数字或字符串。比如：for (int i = 1; i 7; i+)； 2、 而应该使用定义过的常量，比如：for (int i = 1; i NUM_DAYS_IN_WEEK; i+)。 3、 主要变量放在函数的最前面，并分类排列。 4.44.4 详细和编辑页的权限判断顺序详细和编辑页的权限判断顺序 1、 首先判断是否有浏览该页的权限； 2、 然后判断记录是否存在； 3、 最后判断是否有编辑和删除权限。 5 5 编程准则编程准则 5.15.1 变量使用规范变量使用规范 1、 不允许随意定义 public 变量。 2、 一个变量只能有一个用途；变量的用途必须和变量的名称保持一致。 5.25.2 数据库操作规范数据库操作规范 1、 查找数据库表或视图时，只能取出确实需要的那些字段，尽量避免使用(*)通配 符。 2、 使用无关子查询，而不要使用关联子查询。 3、 清楚明白地使用列名，而不能使用列的序号。 5.35.3 对象使用规范对象使用规范 1、 尽可能晚地创建对象，并且尽可能早地释放它。 5.45.4 模块设计原则模块设计原则 1、 函数功能单一，不允许一个函数实现两个及两个以上的功能。 第 7 页 共 10 页 程序设计和编码规范 2、 不能在函数内部使用全局变量，如要使用全局变量，应转化为局部变量。 3、 函数与函数之间只允许存在包含关系，而不允许存在交叉关系。即两者之间只 存在单方向的调用与被调用，不存在双向的调用与被调用。 4、 调用头部控件、底部控件、一览控件、编辑控件、详细控件等公用控件时不需 要写函数进行封装。 5、 多下拉等属性较多的控件必须用函数封装，放在模块的公用类中，并且可以给 其他页面复用。 6、 取得数据源、查询条件以及进行业务逻辑判断的时候语句超过 5 行的，必须使 用函数。 5.55.5 数据库表设计原则数据库表设计原则 1、 每个库表都必须包含一个自动增加的字段为库表的主键。 2、 选择数字类型和文本类型时字段长度尽量充足。 3、 数字类型字段整型使用 INT，非整型使用 DECIMAL。 4、 整型和布尔型字段需要设置默认值。 5、 每个实体表中应该包含以下有用的字段： 1) created_time（datetime，创建时间）在 SQL Server 下设置默认值为 GETDATE() 2) creator_name（nvachar，创建人）保存创建记录的用户名 3) updated_time（datetime，更新时间）保存最近更新时间 4) updater_name（nvachar，更新人）保存最近更新记录的用户名 5) record_order（int，记录排序） 6 6 界面设计规范界面设计规范 6.16.1 基本原则基本原则 1、 明确性：界面每个元素都应该有其存在的理由。 2、 一致性：系统风格和操作方式必须保持一致。 3、 简洁性：操作简洁，实现功能目标的点击数尽可能少，鼠标移动距离尽可能短。 4、 人性化：界面中的文字表述和图标含义力求简单清晰。 6.26.2 版面样式版面样式 1、 必须使用统一的头部控件、尾部控件和导航条控件。 2、 必须使用统一的样式表和图片库。 第 8 页 共 10 页 程序设计和编码规范 3、 同一个图标只能表示一个含义；相同的功能（操作）必须使用相同的图标来表 示。 4、 控件间距必须统一。 6.36.3 保持页面的一致性保持页面的一致性 1、 一览、详细和编辑页使用的字段名称及顺序必须保持一致。 2、 下拉选项中的“全部”和“请选择”等必须使用英文字符的括号“()” 。 3、 下拉列表前的提示文字后不加冒号。 6.46.4 文字表述文字表述 1、 口语化、客气，不要用或少用专业术语，杜绝错别字。 2、 使用中文标点符号，提示信息比较多的话，应该分段。 3、 必须使用统一的用户提示效果和统一的语言描述。 4、 编辑保存时的提示文字和符号使用规范。 1) 提示文字的作用不是要求用户去做什么事情，而是告诉用户系统有些什么规 则，不允许出现“请重新输入” 、 “请正确输入”之类的文字。 2) 提示文字必须清楚地告诉用户应该怎么做才符合系统规则，不允许出现“输 入不合法” 、 “输入不正确”之类的文字。 3) 提示文字示例： A. 时间的提示文字 a) 时间不能小于零。 b) 时间不能大于 8 小时。 B. 数量的提示文字： a) 数量必须大于零。 b) 数量不能小于已出库数量。 C. 判断重复的提示文字 a)“物资编码”不能重复，您输入的物资编码：0601010001 已经存在。 b)2011 年 1 月 12 日早班生产日报已经存在。 4) 提示与报错信息不允许使用感叹号（!） ，而应该使用句号。 6.56.5 B/SB/S 构架适用原则构架适用原则 1、 页面最小：由于 Web 的网络特性，尽可能减小单页面加载量，降低图片文件大 小和数量，加快加载速度，方便用户体验。 2、 屏幕适应：Web 界面需要适应不同用户屏幕大小。 3、 浏览器兼容：需要适应不同浏览器浏览效果，虽然目前可不考虑不同浏览器差 第 9 页 共 10 页 程序设计和编码规范 别，但仍需考虑 IE 浏览器版本差异带来的客户端不同效果。 4、 最少垂直滚动：尽可能减少垂直方向滚动，尽可能少于两屏。 5、 禁止水平滚动：由于将导致非常恶劣的客户体验，尽可能禁止浏览器水平滚动 操作。 7 7 主要名词主要名词/ /动词汉英对照表动词汉英对照表 附件Attach 一览List 详细Detail 编辑Edit 修改Modify 变更Alter 8 8 缩写标准缩写标准 8.18.1 常用缩写常用缩写 addraddress（地址） arrarray（数组） bgbackground（背景） catecategory（种类） corpcorporation(公司) govgovernment（政府） imgimage(图像) incinclude(包括、包含) Infoinformation（信息） MaxMinimum（最小值） MinMaximum（最大值） Msgmessage（消息） NumNumber(数目) NoNumber(号码) picpicture（图画） projproject（工程） pwdpassword（密码、口令） subjsubject（主题） 第 10 页 共 10 页 程序设计和编码规范 syssystem（系统） 8.28.2 前缀缩写前缀缩写 类型前缀类型前缀 类型名称类型名称缩写缩写示例示例 booleanblnblnFound bytebytbytRasterData datetimedtmdtmStart doubledbldblTolerance errorerrerrOrderNum integerintintQuantity longlnglngDistance objectobjobj