项目管理流程机制-v0.7相关开发v1.0

1、目录第一章概述5命名规范5程序命名规范6第二章2命名空间62.1.1页面命名62.1.2类72.1.3控件72.1.4方法82.1.5控件事件82.1.6变量命名82.1.7数据库命名规范92.2表92.2.1主键、外键102.2.2索引10字段10视图.42.2.5过程11函数11包12触发器..9序列12参数12变量.112.2.12第三章编程风格13程序注释133.1类133.1.1属性143.1.2方法、事件143.1.3JS 文件中方法143.1.4页面JS 方法153.1.5数据库注释153.2视图15

2、3.2.1过程、函数163.2.2包163.2.3触发器173.2.4变量173.2.5代码编排风格173.3异常的产生、传递、处理203.4变量的和作用域203.5框架各层213.6M层223.6.1EntityDAL 层223.6.2erface 层22BusFactory 层23WebService 层24Web 层24界面设计24屏幕分辨率、IE、色彩24页面编排要求..6第四章4.14.2Table 布局254.2.1Frame 布局254.2.2字体254.2.3图标、4.2.4 25颜色264.2.5文字对齐方式264.2.6Tab 键顺序2

3、.8 26按钮264.2.9页框264.2.10必录入项设置26编辑控件长度设置2.12控件使用要求27按钮2下拉按钮274.3.2下拉选择274.3.3日期选择274.3.4英文输入274.3.5数字输入274.3.6文本输入274.3.7弹出选择274.3.8查询条件控件284.3.9列表控件284.3.10窗口布局284.4单列表284.4.1左右列表28上下列表28单树28列表28弹出窗口28其他29提示信息2...74.5提示信息捕获原则294.5.1提示信息分类294.5.

4、2显性错误2.1 控件提示2.2 控制性提示30.3 误操作性提示30.4 询问性提示30.5 错误性提示30 隐性错误30第五章开发注意要点31第六章附录31Base 公共方法、属性列表316.1项目使用图标列表35系统保留字列表326.26.3类型简称列表(数据、数据库、类缩写)336.4Excel 导出模板示例错误!未定义书签。6.5自定义控件标识列表错误!未定义书签。6.6常用控件缩写列表346.7常用功能按钮名称列表356.8第一章 概述在建设过程中，将涉及到在新的.Net 以及 J

5、ava上的开发工作。同时，设计、开发和测试较多。为了使应用程序的结构和编码风格标准化，便于阅读和理解编码，以提高开发效率和产品的标准化，制订一套开发规标准势在必行。此外，好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。希望开发严格遵守此套开发规标准，并到自己的程序中。一组通用目的的编码约定应该定义完成上述目的所必需的、能让程序员地创建程序逻辑和功能流程的最小的要求。最小编码约定的目的是使程序易于阅读和理解，从而指导程序员更好地完成开发任务。主要针对使用 Visual Studio.NET 开发的基于Web 的应用系统。第二章 命名规范在命名时，使用恰当含

6、义的英文或共知的英文简称来命名，但最多使用三个英文单词，严禁使用中文拼音及中文拼音简写命名。在命名时，使用 Pascal 风格进行命名。每个单词的首字母大写。除非单独说明为小写的缩写。不应使用系统保留字作为名称对于使用开发工具生成代码，应尽量不进行变更1.1 程序命名规范1.1.1 命名空间例：命名规则 ：项目名_组件类别_组件子类ponents.ServiceM.SysUserponents M 服务组件层系统类ServiceMSysUser - M1.1.2 页面命名例：页面命名前增加功能类别目录规则：以业务类别进行目录区分，并将系统涉及的专有目录进行列出不允许重名。Form 表单 Sys

7、 系统 imagesWorkFlow 工作流 MainFrame 框架 JscriptJS 目录 Css 样式页面命名应该归属于具体的功能目录中，命名规则：模块名称_功能区别名 _扩展名_页类别例：Department_Browse.aspx Department_Browse_ToolBar.aspx Department_Browse_Info.aspx Department_Browse_Tree.aspx Department_Manage_Info.aspx Department_Manage_Sort.aspx Department_Manage_ChangeLeave.aspxD

8、epartment_Manage_User_GridList.aspx部门管理主框架部门管理信息部门管理信息信息浏览部门管理信息部门树 部门管理信息-部门管理信息-排序部门管理信息调级部门管理信息用户信息列表部门管理信息用户岗位Department_Manage_Usost.aspx如果某模块，调用另一模块，那么建立页面的名称以调用模块命名规则为准，并放在对应的功能目录文件夹下。命名规则： 模块名_choose _调用模块名_页类别例：User_Choose_Department_GridList.aspx用户信息列表选择部门模块调用如果某模块，是做为其他几个模块的公共调用，命名规则为： 模块

9、名_choose _页类别例：User_Choose_GridList.aspx用户信息选择(多模块调用)功能区别类别说明：Browse：代表功能模块浏览性页面(框架)Manage：代表功能模块的性页面Choose：代表功能模块所使用到的弹出选择页面页类别说明：ToolBar：代表 GridList：代表列表 Tree： 代表树Info： 代表信息浏览或1.1.3 类应使用名词或名词短语进行命名命名时，使用 Pascal 风格对于相关类建议使用组合词来进行派生类名长度不应超过 5 个单词对于接口类， 应使用 I 开头建议使用组合词来命名派生类如：Table、TableCell1.1.4 控件例

10、：公司名项目名_组件类别_组件子类_组件实现命名规则：ORIGINEntORIGINmonUI.Web.WebGrid.GridItemType- 代表公司名EntriseLibrary - 项目名CommonUI.Web - 组件类别WebGrid - 组件子类GridItemType - 组件实现对于项目中控件的前缀、缩写详见：1.1.5 方法应使用动词或动词短语来命名命名时，使用 Pascal 风格可使用约定缩写，其他应使用英文全写例：SetName()设置名称ClearQueryValue()清除查询条件值1.1.6 控件事件控件事件应使用工具直接生成名称，不应进行变更命名规则： 触发

11、对象_On 触发事件名例： btnSave_OnClick btnSave_OnDblClick注： On 第一个字母应大写1.1.7 变量命名应使用名词短语来命名JS、CS 方法的变量命名规则：m变量名例：mLength = 0 ;JS 方法、CS 方法的参数命名规则：数据表字段类：例：参数数据类型字段名strF_UserNamelngF_UserID用户名(字符串)用户 ID(长整型)非数据表字段类： 参数数据类型参数名例：Length数据表 Moden 类：例：TBUSER长度(短整型)TB业务名用户表 M、输出类型参数应添加前缀 ref、out 并且ref 参数应放在out 参数之前例

12、：Public void XT_GetUserName(longlngF_UserID, refstring strF_UserName, outErrCode )常用 数据类型缩写， 参见： 6.4 类型简称列表(数据、数据库、类缩写)1.1.8 htc命名规则： 业务名_模块名_选择功能名例：System_User_Department 用户部门选择System_User_Sion用户岗位选择1.1.9 隐藏控件隐藏数据库字段命名规则： hid字段名例：hidF_UserID ：隐藏用户 ID隐藏非数据库字段命名规则： hid含义名例：hidListLength ：列表长度1.2 数据库命

13、名规范1.2.1 表应以业务名称英文或英文缩写进行命名表名不应超过 30 个字符表最多只能为三级，每级之间使用 _ 下划线进行分割命名规则：TB_业务类别英文_业务名英文例：TB_SYSTEM_USERTB：表 SYSTEM：系统类 USER：用户表TB_BASE_STOCKROOMTB：表BASE：基础类 STOCKROOM：库房表对于组合的业务名，应进行英文连写，不能使用_下划线进行分割例：TB_SYSTEM_USHOTO用户相片表1.2.2 主键、外键命名规则：主键：PK_表名外键：FK_表名例：PK_TB_SYS_USER用户表主键FK_TB_SYS_DEPATENT 部门表外键1.2

14、.3 索引命名规则：IDX_表名扩展名例：IDX_TB_SYS_DEPARTMENTIDX_ TB_SYS_DEPARTMENTUSER部门索引部门用户索引1.2.4 字段应以字段具体含义英文进行命名，并全为大写应在备注中注明该字段具体中文含义。 如果该字段是外键，应写明关联数据表名。如果该字段为枚举值，应在备注中写明各枚举值含义命名规则：F_字段含义英文例：F_DEPARTMENTIDF_ENABLEFLAG备注：(部门 idTB_SYS_DEPARTMENT.F_ DEPARTMENTID)备注：(启用标志：0 时启用、1 时禁用)1.2.5 视图应以业务表名进行命名名称不应超过 30 个

15、字符名称最多只能为三级命名规则：VIEW_业务类别_业务名_扩展类型数据表扩展视图应添加扩展类型例：非扩展：View_Sys_UserView：视图 SYS：系统类YHXX：业务名，用户信息扩展：View_Sys_User_OnLine VIEW：视图SYS：系统类User_OnLine：用户1.2.6过程应以业务名进行命名，并全为大写名称不应超过 40 个字符名称最多只能为三级命名规则：Proc_业务类别_业务名_扩展名操作类型应以动词作为命名， 扩展名应以名词作为命名例：非扩展：Proc_Sys_User_Insert(添加用户信息)Proc_Sys_User_Filter(用户信息)扩展

16、： Proc_Sys_User_UpdateDisableFlag Proc_Sys_User_OnLineFilter (Proc_Sys_User_DeleteForDepatentID(更新用户停用标志)用户信息)(根据部门 ID 删除用户信息)1.2.7 函数命名规则：业务类：Fun_业务类别_业务名称_扩展名称例：FUN_SYS_USER_DISABLEFLAG(用户停用标志)1.2.8 包命名规则： Pkg_业务类别 _业务名称扩展名称例：非扩展PKG_SYSTEM扩展PKG_SYSTEM_FRAMEWORK(系统处理包)(系统处理包-框架相关)对于包中的例：过程及函数，命名规则：

17、前缀_业务名称_护展名称Proc_User_LoginCheck(用户登陆验证处理)1.2.9 触发器命名规则： TRG_业务类别_ 业务名称_BEF/AFT_操作类型_护展类型例：Trg_Sys_User_Bef_Insert(系统用户添加前触发器)Trg_Sys_User_BefAft_Insert (系统用户添加前、后触发器)Trg_Sys_User_Bef_Insert_Validate(通过触发器在之前验证用户信息)操作类型分为： Insert 、 Update 、Delete1.2.10 序列命名规则： SEQ_业务类别_ 业务数据表 ID例：SEQ_SYS_USERID系统用户

18、ID 索引(该表名为TB_SYS_USER，主键为F_USERID)1.2.11 参数命名规则：输入参数：如果传入参数为数据库表字段： v_数据库表字段名称如果传入参数为非数据库表字段： v_参数名输出参数：如果输出参数为数据库表字段： out_数据库表字段名称如果输出参数为非数据库表字段： out _参数名如果输入参数类别为数据集： ref_参数名注： v_例：out_ref_ 都为小写Proc_System_UserCheck(v_F_UserID in number,v_CheckType in number, out_F_UserName out varchar2, out_Check

19、Code out number, ref_ErrTable out Sys_Refcursore)1.2.12 变量例：命名规则： m 变量名称mRecordCountnumber;第三章 编程风格.1 程序注释.1.1类在定义一个类之前，应用“/”注释说明类的功能、描述。遵从.NET 对注释的约定，使用历史修改标记来指定类总体注释的开始，用标记它的结束。对类的一些注解说明可以放在 和 对中。以后就可以从这些注解自动得到对代码的说明文档。例：/ /功能：实现用户所需底层方法/描述：无历史：2010-01-02 添加 MAQ Sys_User_Insert 方法2010-01-01 新增 MAQ

20、/ .1.2属性例：/ / *GridCode编码/ public string GridCode.1.3方法、事件例：/ / 绑定数据/ / 当strType=1时，绑定用户信息/ 0 执行成功 1 执行失败strType=0时，绑定用户组信息publicBandData(string strType).1.4JS 文件中方法例：/*功能：获取XML中， 传入指定属性的值参数：strSource strFields： string： string要的XML要获取的属性名称返回：XML中对应属性的文本值要点：无*/ function GetXmlReturnValue(strSour.trFi

21、elds).1.5页面 JS 方法例：事件：/* btnDelete按钮事件（删除） function btnDelete_OnClick()非事件：/*当前XML中某属性值function getXMLNodeValue(strFiled).2 数据库注释.2.1视图1, 应对视图实现功能进行说明2, 应对重要字段进行说明例：Create Or Replace View View_Sys_User as Select user.F_Name,-用户停用标志user.F_DisableFlagFrom TB_SYS_USER.2.2过程、函数1,2,3,应写明过程进行功能说明对重要参数应进行说

22、明如果过程处理业务步骤过多， 应对每步单独进行说明例 1：/* | 过程名称 ：采购管理-采购订单-按需求生成订单 | 功能描述 ：按照采购需求生成订单 |需求单ID输入 |v_F_DemandIDNumber|outExecCode返回代码0成功输出Number返回说明输出|outErrorInfosVARCHAR2 | | designer ：CAIWBcompleted on ：2010-8-5例 2：begin -1, 初始化*相关数据 -2, 进行*数据计算 end ;.2.3包1, 应写出该包所包涵的业务范围2, 应写出该包处理的名称例：/* | 过程名称 ：采购管理 | 功能描述

23、 ：包涵所有采购相关计算过程 | | designer ：CAIWBcompleted on ：2010-8-5|*/|*/| 参数描述 ：参数标识名称输入输出类型.2.4触发器例：/* | 过程名称 ：系统新增 | 功能描述 ：验证当前是否存在相同工号的用户，如果存在抛出错误信息 | | designer ：TTTTTcompleted on ：2010-8-5.2.5变量例：-用户停用标志mDisableFlag number;.3 代码编排风格1,2,程序块要采用缩进风格编写，以 Tab 进行缩进，而不是以空格进行相对独立的程序块之间、变量说明之后，必须加空行if( A = B ).mL

24、ength = 0 ;3,对于较长的语句，要分成多行书写，不能出现屏幕外语句。例：string str = “”;str = “ssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss”; str += “dddddddddddddddddddddddddddddddddddddddddddddddd”;4,对于 循环、判断等语句，若中间有较长的表达式或语句，则要进行适当的划分。在操作符处进行划分，并将操作符放在第二行行首。例：if ( A = B | B = C ./*其他判断|C = D )|*/5, 如果方法有较多参

25、数， 应将每个参数做为单独一行进行划分public void Sys_User_Validate(string str1,string str2, string str3, string str4, string str5, string str6, string str7).6, 在例：string strName;应为：string strName;时， 不允许将多个不同类型的变量在同一行中，应分多行shtLength = 0 ;shtLength = 0 ;7, 对于 if、for、do、while、case、switch、default 等语句自占一行，且 if、for、do、whil

26、e 等语句的执行语句部分无论多少都要加括号例：if (user = NULL) return;应为：if ( user = null)return;8, 程序块的分界符（如大括号和）应各独占一行并且位于同一列，同时与它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及 if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。例：以下为错误书写for (.) if (.)void TestMethod()正确书写如下：for (.)if (.)void TestMethod()9, 对于同一业务功能处理的方法或属性，应适当使用例：#regio

27、n 导出 Excel 属性.#endregion#region#end region 将代码进行分隔显示或隐藏#region 导出 Excel 私有方法.#endregion10, 对于循环、if 判断等，应在操作符左右添加空格例：if (strFilter = | strFilter = null).4 异常的产生、传递、处理出错信息和警告是现问题时系统给出的信息，对于出错信息和警告应该遵循以下原则：允许用户非错误，系统应保护自己不受致命操作的破坏信息以用户可以理解的术语描述，不能报系统错误；信息应提供如何从错误中恢复的建设性意见；信息应错误可能导致那些不量，以便用户检查是否出现了这些情况或

28、帮助用户进行改正；将异常分类，必须包括OTHERS处理不必每个方法都用try-catch，当特定的异常可能发生时才使用。比如，当写文件时，写入失败异常不写太大的 try-catch 模块。如果需要，为每个执行的任务编写单独的 try-catch 模块。这将有助于找出哪一段代码产生异常，并给用户发出特定的错误消息。.5变量的和作用域变量时，应清楚需要使用该变量的最小作用域(全局、类、方法等)在同一作用域中，如果某变量需要在该域包涵的更小域中使用，应在第一次使用前进行时才例：错误写法：private void GetUserName()if( UserNameA = UserNameB )stri

29、ng strName = ; strName = UserNameA;/*程序代码，而不是在每次使用if( UserNameA = UserNameC )string strName = ; strName = UserNameA;/*程序代码正确写法：private void GetUserName(Dastring strName = ;able dtb)if( UserNameA = UserNameB )strName = UserNameA;/*程序代码if( UserNameA = UserNameC )strName = UserNameA;/*程序代码对于在 for、while

30、、foreach循环语句中使用到的变更，例：错误写法：应在该块行事先private void GetUserName(Daable dtb)for (i = 0; i dtb.Rows.Count; i+ )string strUserName = ;strUserName = dtb.Rows0Name.ToString();./*程序代码正确写法：private void GetUserName(Daable dtb)string strUserName = ;for (i = 0; i dtb.Rows.Count; i+ )strUserName = dtb.Rows0Name.ToS

31、tring();./*程序代码.6 框架各层.6.1M层命名规则：1,2,3,以各业务线建立多个业务项目各项目中，包涵该业务线下所有对应数据表对应的 M各业务线项目命名规则为： 业务名例： System4,各业务项目下各数据模型例： TBSystemConfig名规则为： 数据表名(去掉下划线)注意事项：1, M，应能实现序列化与反序列化.6.2EntityDAL 层命名规则：1,2,3,以各业务线建立多个业务项目各项目中，包涵该业务线下所有对应数据表对应的 DAL各业务线项目命名规则为： 业务名例： SYSTEM4,各业务项目下各实体名规则为：DAL数据表名(去掉TB_)例： DALSyst

32、emConfig.cs注意事项：.6.3erface 层命名规则：1, 以各业务线建立多个业务项目2, 各项目中，只有一个接口文件，包涵该业务线下所有对应数据表对应的 DAL 基本方法、DAL 中未实现的护展方法、对于业务的组合方法3, 各业务线项目、接口文件命名规则为： IBus业务名例： IBusSystem注意事项：1, 因为接口层只有一个接口文件，所以该业务线下所有对应的单独业务模块应使用块进行分割例：.6.4BusFactory 层命名规则：1, 以各业务线建立多个业务项目2, 各项目中，只有一个接口文件，包涵该业务线下所有对应数据表对应的 DAL 基本方法、DAL 中未实现的护展方

33、法、对于业务的组合方法3, 各业务线项目、接口文件命名规则为： Bus业务名例：注意事项：1,.6.5Factory 层.6.6WebService 层命名规则：1, 各业务线应建立自己对应的WebService 接口，规则：业务名例：注意事项：.6.7Web 层命名规则：详见：第二章 命名规范 程序命名规范第四章 界面设计4.1屏幕分辨率、IE、色彩开发时，使用机器自带分辨率进行设计， 设计完成后，在成错乱。开发的程序支持当前主流的浏览器(IE、Firefox)1024*768下测试，以保证在不同分辨率下界面不会形开发时使用 IE8 进行开发，并在 IE6、IE7.中进试，以保证浏览器兼容4

34、.2页面编排要求4.2.1Table 布局4.2.2Frame 布局在使用 Frame 布局时，应允分考虑整体布局方式、刷新要求、性能要求，尽量使用最少的 Frame 达到目的(能合并到一个 Frame 中通过 Table 布局方式的，坚绝不用 Frame 进行布局)在设置 Frame 的 frameborder 属性值时，应使用 01 ，而不是使用 noyes， 以免因子页面中使用微软 Ajax 技术报错。在布局中，如果两个并行的 Frame，在通过功能都面版切换时，已加载过的 IFrame 不能刷新例：if(.geementById(IFrameZTSPQX).src = )/*未加载过.

35、geementById(IFrameZTSPQX).src = XT_YH_ZTSPQX_Frame.aspx;else/*已加载过， 不进行加载.geementById(IFrameGNQX).style.display = none;.geementById(IFrameZTSPQX).style.display = ;4.2.3字体4.2.4图标、对于项目中所使用的按钮图标，详细查看 附录： 项目使用图标列表对于项目中所使用的框架背景不能进行变更4.2.5颜色4.2.6文字对齐方式4.2.7Tab 键顺序.9按钮4.2.10 页框4.2.11 必录入项设置4.2.12 编

36、辑控件长度设置4.3控件使用要求4.3.1按钮4.3.2下拉按钮4.3.3下拉选择4.3.4日期选择4.3.5英文输入4.3.6数字输入4.3.7文本输入4.3.8弹出选择4.3.9查询条件控件4.3.10 列表控件4.4窗口布局4.4.1单列表4.4.2左右列表4.4.3上下列表4.4.4单树4.4.5列表4.4.6弹出窗口4.4.7其他4.5提示信息4.5.1提示信息捕获原则不要捕捉了异常却什么也不做，看起来系统似乎在正常运行。如果这样隐藏了一个异常，将底是否发生，为什么发生。不知道异常到发生异常时，给出友好的消息给用户。但要精确名等。错误的所有可能细节，包括发生的时间，和相关方法，类别用

37、像“应用程序出错”，“发现一个错误”等错误提示消息，而应给出类似“更新数据库失败，请确保登陆 id 和正确。”之类的具体消息。显示错误消息时，还应提示用户如何解决问题。如：“更新数据库失败，请确保登陆 id 和是仅仅说“更新数据库失败”。正确。”，而不显示给用户的消息要简短而友好。但要把所有可能的信息都下来，以助问题。4.5.2提示信息分类显性错误显性错误是指开发能预见的错误，如输入类型错误、验证性错误等。.1 控件提示输入性控件应在用户输入时，根据验证规划进行及时提示..2 控制性提示当用户保存数据时，系统验证当前名称字段是否为空，如果为进行提示输入

38、。.3 误操作性提示例：当用户输入信息后，不单击关闭，系统自动提示信息.4 询问性提示例：当用户选择删除某用户信息时，删除确认提示.5 错误性提示例：用户进行正常操作时，系统自动判断当前用户操作是否满足系统要求，如不满足进行提示，为用户问题所在。隐性错误隐性错误是指开发不能预见的错误，如未知的数据错乱、未知的网络问题等，对于隐性错误应能在出错时转到公共显示错误页面进行提示。第五章开发注意要点第六章附录6.1BasePage 公共方法、属性列表方法列表：方法名称备注类别注意要点属性列表：6.2系统保留字列表AddHandlerAddress

39、OfAliasAndAndAlsoAnsiAsAssemblyAutoByRefByteByValCallCaseCatchCBoolCByteCCharCDateCDecCDblCharCClassCLngCObjConstCShortCSngCStrCTypeDateDecimalDeclareDefaultDelegateDimDirectCastDoDoubleEachElseElseIfEndEnumEraseErrorEventExitFALSEFinallyForFriendFunctionGetGetTypeGoSubGoToHandlesIfImplementsImportsInInheritsegererfaceIsLetLibLikeLongLoopMeModModuleMustInheritMustOverrideMyBaseMyClassNamespaceNewNex