《广东电信综合业务支撑系统（IBSS）总体设计说明书－开发规范分册(V2.0).doc》由会员分享，可在线阅读，更多相关《广东电信综合业务支撑系统（IBSS）总体设计说明书－开发规范分册(V2.0).doc（31页珍藏版）》请在三一办公上搜索。
1、广东省电信综合业务支撑系统（IBSS）开发规范说明书编制： 部门职位： 日期：_审核： 部门职位： 日期：_批准： 部门职位： 日期：_ 广州南方电信系统软件有限公司版权所有 不得复制目 录第一章 引言41.1 编写目的41.2 背景41.3 文档地图41.4 术语定义41.5 参考资料4第二章 通用编码规范52.1 排版52.2 注释52.3 命名62.4 可读性62.5 变量62.6 函数、过程62.7 可测性72.8 程序效率72.9 质量保证72.10 代码编译8第三章 DELPHI前端开发设计规范93.1 软件模块设计93.1.1 开发工具93.1.2 文档的建立和管理93.1.3
2、版本控制93.1.4 注释和功能描述103.1.5 菜单打开窗体的引出函数声明103.1.6 修改103.1.7 发布的公用资源，多使用类103.2 编码设计113.2.1 命名规则11第四章 CICS开发规范194.1 命名规则194.1.1 通用规则194.1.2 Program命名204.1.3 函数/过程命名204.1.4 变量命名204.1.5 宏定义214.2 程序的书写规范214.2.1 嵌入式SQL 的书写规范214.2.2 空行214.2.3 代码行214.2.4 对齐224.2.5 修饰符的位置224.2.6 注释224.3 开发注意事项234.3.1 平台支持234.3.
3、2 CICS Program 中禁止使用的函数234.3.3 CICS Program 中不推荐使用的函数234.3.4 宿主变量（Host Variable）可用数据类型234.3.5 数据类型兼容244.3.6 Char 数据类型的使用244.3.7 Varchar数据类型的使用244.3.8 统一编译选项244.3.9 统一日期格式244.3.10 字符集254.3.11 防止头文件的多重包含254.4 开发建议25第五章 数据库设计规范265.1 数据库中对象命名原则265.2 数据库中对象前缀的定义265.3 库表命名原则265.4 库表类别划分275.5 字段命名规则285.6 字
4、段类型规范305.7 存储过程和触发器命名规则305.8 主键和索引命名规则305.9 设计规则30第一章 引言1.1 编写目的为了规范设计和代码风格，提高代码质量，增强程序的可读性和可维护性，特编写本文档。预期读者：项目提出方以及用户方相关技术人员、项目开发组成员、质量控制人员。1.2 背景系统名称：综合业务支撑系统项目提出人：广东省电信公司项目开发者：广州南方电信系统软件有限公司用户：广东省电信公司、广东省电信公司地市级分公司1.3 文档地图本文档定义了开发的规范，包括以下几个方面：通用编码规范DELPHI前端开发设计规范CICS中间件开发规范数据库设计规范1.4 术语定义无。1.5 参考
5、资料广东省电信综合业务支撑系统业务需求分析书 V2.0 广东省电信公司广东省电信综合业务支撑系统技术规范广东省电信公司 计算机软件产品开发文件编制指南GB 8567-88 计算机软件质量保证计划规范GB/T 12504-90 计算机软件配置管理计划规范GB/T 12505-90第二章 通用编码规范2.1 排版关键词和操作符之间加适当的空格。相对独立的程序块与块之间加空行。较长的语句、表达式等要分成多行书写。划分出的新行要进行适应的缩进，使排版整齐，语句可读。长表达式要在低优先级操作符处划分新行，操作符放在新行之首。循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。若函数或过程中的参
6、数较长，则要进行适当的划分。不允许把多个短语句写在一行中，即一行只写一条语句。函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。C/C+语言是用大括号和界定一段程序块的，编写程序块时和应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。2.2 注释 注释要简单明了。边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。在必要的地方注释，注释量要适中。注释的内容要清楚、明了，含义准确，防止注释二义性。保持注释与其描
7、述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻位置，不可放在下面。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释应放在此域的右方；同一结构中不同域的注释要对齐。变量、常量的注释应放在其上方相邻位置或右方。全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；生成日期；模块功能描述（如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等）；主要函数或过程清单及本文件历史修改记录等。在每个函数或过程的前面要有必要的注释信息，包括：函数或过程
8、名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。2.3 命名较短的单词可通过去掉“元音”形成缩写；较长的单词可按单词的头几个发音符的优先级。使用匈牙利表示法。2.4 可读性避免使用不易理解的数字，用有意义的标识来替代。不要使用难懂的技巧性很高的语句。源程序中关系较为紧密的代码应尽可能相邻。2.5 变量去掉没必要的公共变量。构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的公共变量，防止多个不同模块或函数都可以修改、创建同一公共变量的现象。仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。明确公共变量与操作此公共变量的函数或过程的关系，如访问、修
9、改及创建等。当向公共变量传递数据时，要十分小心，防止赋与不合理的值或越界等现象发生。防止局部变量与公共变量同名。仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减少引起误用现象。结构的设计要尽量考虑向前兼容和以后的版本升级，并为某些未来可能的应用保留余地（如预留一些空间等）。留心具体语言及编译器处理不同数据类型的原则及有关细节。严禁使用未经初始化的变量。声明变量的同时对变量进行初始化。编程时，要注意数据类型的强制转换。2.6 函数、过程函数的规模尽量限制在200行以内。一个函数最好仅完成一件功能。为简单功能编写函数。函数的功能应该是可以预测的，也就是只要输入数据相同就应产生
10、同样的输出。尽量不要编写依赖于其他函数内部实现的函数。避免设计多参数函数，不使用的参数从接口中去掉。用注释详细说明每个参数的作用、取值范围及参数间的关系。检查函数所有参数输入的有效性。检查函数所有非参数输入的有效性，如数据文件、公共变量等。函数名应准确描述函数的功能。避免使用无意义或含义不清的动词为函数命名。函数的返回值要清楚、明了，让使用者不容易忽视错误情况。明确函数功能，精确（而不是近似）地实现函数设计。减少函数本身或函数间的递归调用。编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段对其加以保护。2.7 可测性在编写代码之前，应预先设计好程序调试与测试的方法和
11、手段，并设计好各种调测开关及相应测试代码如打印函数等。在进行集成测试/系统联调之前，要构造好测试环境、测试项目及测试用例，同时仔细分析并优化测试用例，以提高测试效率。2.8 程序效率编程时要经常注意代码的效率。在保证软件系统的正确性、稳定性、可读性及可测性的前提下，提高代码效率。不能一味地追求代码效率，而对软件的正确性、稳定性、可读性及可测性造成影响。编程时，要随时留心代码效率；优化代码时，要考虑周全。要仔细地构造或直接用汇编编写调用频繁或性能要求极高的函数。通过对系统数据结构划分与组织的改进，以及对程序算法的优化来提高空间效率。在多重循环中，应将最忙的循环放在最内层。尽量减少循环嵌套层次。避
12、免循环体内含判断语句，应将循环语句置于判断语句的代码块之中。尽量用乘法或其它方法代替除法，特别是浮点运算中的除法。2.9 质量保证在软件设计过程中构筑软件质量。代码质量保证优先原则正确性，指程序要实现设计要求的功能。稳定性、安全性，指程序稳定、可靠、安全。可测试性，指程序要具有良好的可测试性。规范/可读性，指程序书写风格、命名规则等要符合规范。全局效率，指软件系统的整体效率。局部效率，指某个模块/子模块/函数的本身效率。个人表达方式/个人方便性，指个人编程习惯。只引用属于自己的存贮空间。防止引用已经释放的内存空间。过程/函数中分配的内存，在过程/函数退出之前要释放。过程/函数中申请的（为打开文
13、件而使用的）文件句柄，在过程/函数退出前要关闭。 防止内存操作越界。时刻注意表达式是否会上溢、下溢。认真处理程序所能遇到的各种出错情况。系统运行之初，要初始化有关变量及运行环境，防止未经初始化的变量被引用。系统运行之初，要对加载到系统中的数据进行一致性检查。严禁随意更改其它模块或系统的有关设置和配置。不能随意改变与其它模块的接口。充分了解系统的接口之后，再使用系统提供的功能。要时刻注意易混淆的操作符。当编完程序后，应从头至尾检查一遍这些操作符。不使用与硬件或操作系统关系很大的语句，而使用建议的标准语句。建议：使用第三方提供的软件开发工具包或控件时，要注意以下几点：充分了解应用接口、使用环境及使
14、用时注意事项，不能过分相信其正确性。除非必要，不要使用不熟悉的第三方工具包与控件。2.10 代码编译编写代码时要注意随时保存，并定期备份，防止由于断电、硬盘损坏等原因造成代码丢失。同一项目组内，最好使用相同的编辑器，并使用相同的设置选项。合理地设计软件系统目录，方便开发人员使用。打开编译器的所有告警开关对程序进行编译。在同一项目组或产品组中，要统一编译开关选项。使用工具软件（如Visual SourceSafe）对代码版本进行维护。第三章 DELPHI前端开发设计规范3.1 软件模块设计3.1.1 开发工具统一采用Delphi 6开发，每个模块有自己的编号，在程序设计中应严格按编号设计编码。3
15、.1.2 文档的建立和管理 每个模块的所有文档的建立由设计者完成，所有设计说明，更改文档要向(172.16.3.83d:TOSSdoc)提交，当模块发生更改后文档的更新必须即时完成，生成的运行文件向172.16.3.83d:TOSS Bin)提交。 对设计文档的修改应加上修改人的名字及时间，如： procedure ShowConfig(oDB:TDatabase); /张三 1999.08.26procedure ShowConfig(oDB:TDatabase);stdcall; 各子系统的模块组相对独立，每个子系统的模块的调用由主控程序完成; 各子系统的模块组都是一个包方式的DLL文件，
16、确实有困难的采用EXE文件，通过选中Project-Options-Packages下Build with runtime packages进行设置。3.1.3 版本控制版本的构成，如：V01。2001。11。23 后面几位一般来说是提交日期，版本号的修改由程序员自己完成，版本修改后必须进行版本发布，使程序的版本号与库表发布时的版本号一致。 每个DLL的工程文件必须包括版本信息的全局变量，包含取版本信息函数，以便主控程序做版本检测；每个DLL必须包含版本控制函数GetVersionInfo，并且在exports中申明。取版本信息var VersionInfo :TVersion = (Prod
17、uct:XXX模块;Version:V1.0.1999.08.11;Author:ABC;UpdateDate:19990815);function GetVersionInfo:TVersion;stdcall;begin Result := VersionInfo;end;3.1.4 注释和功能描述每个模块前要 有模块的功能描述，输入输出参数，时间，创建人员等；注释在函数或命令行语句的上方；3.1.5 菜单打开窗体的引出函数声明菜单动态调用DLL文件打开窗体的必须要有一个引出函数或过程在接口部分声明引出函数或过程； DLL项目文件中在Exports 子句引出了DLL中应用程序要调用的函数或
18、过程；3.1.6 修改对模块的修改必须注意对文档的更新，特别是对初始化程序的修改。注明修改原因，修改人，修改时间，以便以后维护人员的代码了解；3.1.7 发布的公用资源，多使用类建议建立一个公用资源库（NDPublic.dll），这个资源库包含一些常用的功能函数，功用控件等 ，开发时使用方法是将NDPublic.PAS文件加入你的工程中去。使用静态调用的方式使用；建立几个基本窗口（如，父窗口，编辑，查找等），大家的其他窗口可以从这几个窗口中继承下来用。鼓励大家将自己设计的其他窗口提炼出来让大家一起使用。 请多使用类的方法解决问题，如果可能可以将相对独立的对象建成VCL控件或OCX控件，便于资源
19、重复利用。公用资源库，公共父窗体的修改更新最好由专人管理，发布更新；3.2 编码设计3.2.1 命名规则指在软件设计中涉及到的各种对象（应用、窗口、菜单等）以及变量的命名的一套方法。命名的基本规则是简单明了，尽量使用长命名方式，功能命名可以是汉语简拼和英文。A、文件命名：项目文件：项目文件的名称应当具有描述意义，如综合管理的项目工程文件：zhgl.dpr窗体文件: 窗体文件的名称应当表达出窗体的用途，且具有F r m前缀如主窗口；FrmMain, 对应的模块编号：0500000001数据模块文件: 数据模块文件的名称应当表达出数据模块的作用，且具有D M 前缀,如部门的数据模块文件：DMDep
20、artment.dfm单元文件:1. 普通单元的结构(1) 单元名单元的名称应当有描述性。例如，应用程序的主窗体单元叫Main.pas 。(2) Uses 句子Interface部分的Uses子句应当只包含该部分需要的单元。不要包含可能由Delp hi自动添加的单元Implementation部分的Uses子句应当只包含该部分需要的单元，不要有多余的单元。(3) Interface 部分Interface 部分应当只包含需要被外部单元访问的类型、变量、过程与函数的声明。而且，这些声明应当在Implementation部分之前。(4) Implementation 部分Implementatio
21、n 部分包括本单元私有的类型、变量、过程与函数的实现。(5) Initialization 部分不要在Initialization 部分放置花费时间很多的代码。否则，将导致应用程序启动时显得很慢。(6) Finalization 部分确保释放所有在Initialization 部分中分配的资源。2. 窗体单元窗体单元文件的名称与相应的窗体名称相同。例如，About 窗体的名称叫FrmAbout 。单元文件名称叫About.pas 。3. 数据模块单元数据模块单元文件的名称与相应的数据模块名称相同。例如，数据模块单元的名称叫DMDepartment.pas。4. 通用的单元通用单元的名称应当表达
22、出它的用途。例如，一个实用工具单元的名称叫ugUtilities.pas ，包含全局变量的单元名称叫CustomerGlobals.pas 。注意，一个项目中单元名称必须是唯一的。通用单元名不能重名。5. 组件单元组件单元应放在单独的路径中，以表明它们是定义组件的单元。它们一般与项目不放在同一路径下。单元文件名称应表达出其内容。文件头:所有源文件和项目文件都应具有文件头。一个正确的文件头应包含以下信息：Copyright YEAR by AUTHORSB、变量的命名范围前缀举例参数（Argument）aaName全局（Global）ggName实例（Instance）iiName局部（Loca
23、l）llName共享（Shared）ssName系统全局变量（一般只有如下几个）待定C、过程和函数(子程序) 子程序名应该以大写字母开头,而且应该易于阅读.下面是一个正确格式的子程序名: procedurethisisapoorlyformattedroutinename; 下面是一个首字母适当大写的子程序名: procedureThisIsMuchMoreReadableRoutineName; 子程序名应该具有与其用途相关的含义.导致发生某动作的子程序应该以动词为前缀命名,例如: procedureFormatHardDrive; 为输入参数赋值的子程序应该以Set为前缀命名,例如: pr
24、ocedureSetUserName; 取回数值的子程序应该以Get为前缀命名,例如: functionGetUserName:string; 形参(FormalParameters) 格式 在可能的情况下,同类型的形参应该在一条语句中说明: procedureFoo(Param1,Param2,Param3:Integer;Param4:string); 命名 所有的形参名称应该具有与其用途相关的含义,而且不应该基于传递到子程序的标识符名称.适当情况下,参数名应该以字符A为前缀,例如, procedureSomeProc(AUserName:string;AUserAge:integer);
25、 使用前缀A是一种约定,以便参数名与类的属性名、域名重复时消除歧义. 参数顺序 下面的形参顺序主要是为在寄存器模式下得到更高的性能,寄存器模式是惯用的调用模式.调用者最常使用的参数应该在参数的最前位置,使用越少的参数,其位置应该越在右面.D、组件实例的命名规则: 组件的名称应当具有描述性。Delp h i 没有为组件指定默认的名称。单元命名要使用一个变更了的匈牙利命名规范。在这个标准中，组件名包括两个部分：前缀和性质标识名 例如：TLabel前缀为lbl， TEdit为edt等，具体的见附表2-2E、编程公用约定1、USE 字句implementation部分的uses子句应该只包括imple
26、mentation部分中代码需要的单元.无关的单元名应该删除; 该部分应该包括类型本单元私有的类型声明,变量声明,过程/函数2、不要将耗费大量时间的代码放在单元的initialization部分.这将导致应用程序启动缓慢3、匹配的beginend要对齐，新的关键字相对于上一行向右移两格，begin,end语句应该单独作为一行,例如：if . Then begin end;with的层次最好不超过三层。 4、确保你释放了在Initialization部分分配的全部项目5、任何可能的地方,所有的资源分配代码都必须以try.finally结构保护起来6、try.except应该只在你需要在产生意外时
27、执行任务的情况下使用.一般来说,你不需要使用try.except来简单地显示错误信息,因为应用程序将通过Appl ication对象自动实现这一点.在except子句中,如果你希望在执行过自己的 任务后再调用缺省的意外处理程序,应该使用raise来再次产生这个意外.F、注释和功能描述 建议在所有的源文件,工程文件,单元文件等中使用包含信息的文件头，有模块的功能描述，参数，时间，创建人员等； 注释在函数或命令行语句的上方；六、数据模块窗口（DM）1、所有数据字典下载的数据集控件都放在该数据模块窗口中，供系统统一使用。2、所有子窗体用到的字典数据都通过引用该窗口得到，该数据模块窗口统一由专人维护。
28、附表：Standard页面 前缀组件 mmTMainMenu pmTPopupMenu mmiTMainMenuItem pmiTPopupMenuItem lblTLabel edtTEdit memTMemo btnTButton cbTCheckBox rbTRadioButton lbTListBox cbTComboBox scbTScrollBar gbTGroupBox rgTRadioGroup pnlTPanel clTCommandList Additional页面 前缀组件 bbtnTBitBtn sbTSpeedButton meTMaskEdit sgTStringG
29、rid dgTDrawGrid imgTImage shpTShape bvlTBevel sbxTScrollBox clbTCheckListbox splTSplitter stxTStaticText chtTChart Win32页面 前缀组件 tbcTTabControl pgcTPageControl ilTImageList reTRichEdit tbrTTrackBar prbTProgressBar udTUpDown hkTHotKey aniTAnimate dtpTDateTimePicker tvTTreeView lvTListView hdrTHeaderCo
30、ntrol stbTStatusBar tlbTToolBar clbTCoolBar System页面 前缀组件 tmTTimer pbTPaintBox mpTMediaPlayer olecTOleContainer ddccTDDEClientConv ddciTDDEClientItem ddscTDDEServerConv ddsiTDDEServerItem Internet页面 前缀组件 cskTClientSocket sskTServerSocket wbdTWebDispatcher ppTPageProducer tpTQueryTableProducer dstpTD
31、ataSetTableProducer nmdtTNMDayTime necTNMEcho nfTNMFinger nftpTNMFtp nhttpTNMHttp nMsgTNMMsg nmsgTNMMSGServ nntpTNMNNTP npopTNMPop3 nuupTNMUUProcessor smtpTNMSMTP nstTNMStrm nstsTNMStrmServ ntmTNMTime nudpTNMUdp pskTPowerSock ngsTNMGeneralServer htmlTHtml urlTNMUrl smlTSimpleMail DataAccess页面 前缀组件 d
32、sTDataSource tblTTable qryTQuery spTStoredProc dbTDataBase ssnTSession bmTBatchMove usqlTUpdateSQL DataControls页面 前缀组件 dbgTDBGrid dbnTDBNavigator dbtTDBText dbeTDBEdit dbmTDBMemo dbiTDBImage dblbTDBListBox dbcbTDBComboBox dbchTDBCheckBox dbrgTDBRadioGroup dbllTDBLookupListBox dblcTDBLookupComboBox d
33、breTDBRichEdit dbcgTDBCtrlGrid dbchTDBChart DecisionCube页面 前缀组件 dcbTDecisionCube dcqTDecisionQuery dcsTDecisionSource dcpTDecisionPivot dcgTDecisionGrid dcgrTDecisionGraph QReport页面 前缀组件 qrTQuickReport qrsdTQRSubDetail qrbTQRBand qrcbTQRChildBand qrgTQRGroup qrlTQRLabel qrtTQRText qreTQRExpr qrsTQRS
34、ysData qrmTQRMemo qrrtTQRRichText qrdrTQRDBRichText qrshTQRShape qriTQRImage qrdiTQRDBMImage qrcrTQRCompositeReport qrpTQRPreview qrchTQRChart Dialogs页面 Dialog组件是封装在组件内部的实际窗体.因此应该遵循窗体的命名约定.类型 实例名称应该与不带数字后缀的类型实例名称相同,如下: 类型实例名称 TOpenDialogOpenDialog TSaveDialogSaveDialog TOpenPictureDialogOpenPictureD
35、ialog TSavePictureDialogSavePictureDialog TFontDialogFontDialog TColorDialogColorDialog TPrintDialogPrintDialog TPrintSetupDialogPrinterSetupDialog TFindDialogFindDialog TReplaceDialogReplaceDialog Win31页面 前缀组件 dbllTDBLookupList dblcTDBLookupCombo tsTTabSet olTOutline tnbTTabbedNoteBook nbTNoteBook
36、hdrTHeader flbTFileListBox dlbTDirectoryListBox dcbTDriveComboBox fcbTFilterComboBox Samples页面 前缀组件 ggTGauge cgTColorGrid spbTSpinButton speTSpinEdit dolTDirectoryOutline calTCalendar ibeaTIBEventAlerter ActiveX页面 前缀组件 cfxTChartFX vspTVSSpell f1bTF1Book vtcTVTChart grpTGraph Midas页面 前缀组件 prvTProvide
37、r cdsTClientDataSet qcdsTQueryClientDataSet dcomTDCOMConnection oleeTOleEnterpriseConnection sckTSocketConnection rmsTRemoteServer midTmidasConnection第四章 CICS开发规范4.1 命名规则4.1.1 通用规则本节论述的通用规则是被大多数程序员所采纳和接受的，我们应当在遵循这些共性规则的前提下，再扩充特定的规则。l禁用系统保留字不用使用系统的保留字来命名标识符，例如不要使用 CICS、EXEC 、BEGIN、END 等来做标识符。l标识符应当直观
38、且可以拼读，可望文知意，不必进行“解码”。标识符最好采用英文单词或其组合，便于记忆和阅读。不建议使用汉语拼音来命名。程序中的英文单词一般不会太复杂，用词应当准确。例如不要把CurrentValue写成NowValue。l标识符的长度应当符合“min-length & max-information”原则。一般来说，长名字能更好地表达含义，所以函数名、变量名长达十几个字符不足为怪。但是，不是名字越长就约好。 例如变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常可用作函数内的局部变量。l命名规则尽量与所
39、采用的操作系统或开发工具的风格保持一致。例如Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild。而Unix应用程序的标识符通常采用“小写加下划线”的方式，如add_child。别把这两类风格混在一起用。l程序中不要出现仅靠大小写区分的相似的标识符。例如：int x, X;/ 变量x 与 X 容易混淆void foo(int x);/ 函数foo 与FOO容易混淆void FOO(float x);尽量避免名字中出现数字编号，导致产生无意义的标识符，如Value1,Value2等，除非逻辑上的确需要编号。4.1.2 Program命名本节论述的CICS 中PD 中Pr
40、ogram 的命名规则。Program 的名称不能超过八个字符；在Program 命名中，可用的字符为 A-Z，a-z，0-9，$ and .，但是CICS 会自动将小写字母转换成大写字母；待添加的隐藏文字内容1不要使用CICS 中的保留字，如CICS 、EXEC，也不要使用 CICS、DFH 、ERZ 、FAA 等作为前缀；Program的命名应应清晰准确的表达Program的功能或用途。Program可以使用一个或多个单词描述命名，当长度超过八个字符时，应采用宿写。例如： LOADDICTGETRTYPEProgram对应的文件名（包括.pc文件、可执行文件），与Program命名保持一致
41、。4.1.3 函数/过程命名函数/过程的命名应能清晰准确的描述函数/过程的功能或用途，并具可读性。函数/过程可以使用一个或多个单词描述命名，采用“大小写”混排的方式，第一个字母小写，其后每个单词的第一个字母要大写，其它字母小写。例如： normalExit()、checkError()。函数参数的命名，除了没有 Prefix 之外，其余同变量的命名方式。4.1.4 变量命名变量采用匈牙利命名法，同时结合C的原则；一般情况下，变量的取名方式为：其中Prefix和BaseType 都采用小写，Description由一个或多个单词组成，采用“大小写”混排的方式，每个单词的第一个字母大写，其它字母小
42、写。例如： gcModuleName 定义一个char 类型的全局变量Prefix描述变量的使用方式，有关项目的全局变量必须用g_开始，静态变量s_，局部变量可以不加前缀，也可以采用l_用以显示说明该变量是局部变量。前缀类型备注G全局变量S静态变量L局部变量BaseType指定变量的数据类型。以下表中列出了C语言各种数据类型的前缀。前缀类型例子ccharcNamebboolbEnableiIntiLengthffloatfWidthsshortsHeightLlonglSalaryddoubledAgep*pDocuunsigned4.1.5 宏定义以一个或多个有意义的单词组成；单词全部大写；
43、单词之间以“_“分隔；例如：#define MAX(a,b) blah#define LINK_SUCCESS 4.2 程序的书写规范程序的书写规范虽然不会影响程序的功能，但会影响可读性。程序的书写应追求清晰、美观。4.2.1 嵌入式SQL 的书写规范EXEC SQL 大写；lOracle 中的关键字大写（如：SELECT、DELETE 、FROM 等）；lSQL语句中的表名、字段名小写。4.2.2 空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，所以在程序中要适当得用空行。在每个类声明之后、每个函数定义结束之后都要加空行。在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。4.2.3 代码行一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
