普英集团Deplhi源代码编写规范.doc

《普英集团Deplhi源代码编写规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、计算机源代码编写规范普英集团Delphi源代码编写规范Version<1.0>撰写人：薛永坤审核人：刘吉鹏批准人：刘吉鹏日期：2007-3-5文件修改控制修改记录编号修改状态修改页码及条款修改人审核人批准人修改日期计算机源代码编写规范目录1.目的2.适用范围3.规范内容3.1标识符命名及书写规范3.2注释规则3.3缩进规则3.4窗体3.5控件3.6提示信息计算机源代码编写规范1.目的良好的编程风格是提高程序可靠性非常重要的手段，也是大型项目多人合作开发的技术基础。本规范的目的在于通过规范定义来避免不好的编程风格，增强程序

2、的易读性，便于自己和其它程序员理解，以下是程序开发工作流程图。2.适用范围本规定适用于所有软件的源程序编写。客户有特殊要求时，则遵循客户提出的要求。对于移植性开发或低版本的升级开发，则按照该版本的格式要求。3.规范内容3.1标识符命名及书写规则3.1.1基本规则计算机源代码编写规范1)这里的标识符是指编程语言中语法对象的名字，它们有常量名、变量名、函数名、类和类型名、文件名等，标识符的基本语法是以字母开始，由字母数字及下划线组成的单词。2)标识符本身最好能够表明其自身的含义，以便于使用和他人阅读。按其在应用中的含义由一个

3、或多个词组成。可以是英文词或中文拼音词。3)当标识符由多个词组成时，每个词的第一个字母大写，其余全部小写，常量标识符全部大写。中文词由中文描述含义的每个汉字的头一个拼音字母组成。英文词尽量不缩写，如果有缩写，在同一系统中对同一单词必须使用相同的表示法。4)标识的总长度不要超过32个字符。5)具体的3.1.2具体约定1)窗体及单元的命名一个窗体的命名由四部分组成：“Frm”+“公司（B/R/X/…）”+“模快（PUR/INV/…）”+“具体的窗体名”。如：FrmBSysReportShowFrmRPurPurchaseOr

4、derFrmRSysConnection……一个单元的命名由四部分组成：“Unt”+“公司（B/R/X/…）”+“模快（PUR/INV/…）”+“具体的窗体名”。如：UntBSysReportShowUntRPurPurchaseOrderUntRSysConnection……2)变量及控件的命名一个变量的命名由三部分组成：“范围前缀”+“类型前缀”+“变量名字”。变量范围分为三种：全局变量，在模块中public处以xxx:xxx;来定义，加前缀“G”。如：GStrUserName；GStrDeptName模块变量，在模

5、块中private处以xxx:xxx;来定义，加前缀“M”。如：MStrSQL；MStrFlag过程变量，在函数或过程中Varxxx:xxx;来定义，不加范围前缀。类型前缀按照其变量类型的不同采用以下字符：序号类型前缀Example1BooleanBlnBlnFound计算机源代码编写规范2Date(Time)DtmDtmStart3IntegerIntIntQuantity4StringStrStrFName5User-definedtypeUdtUdtEmployee6CurrencyCurCurRevenue7Do

6、ubleDblDblTolerance8ByteBytBytRasterData9VariantVntVntCheckSum10SingleSngSngAverage11EditEdtEdtName12BottonBtnBtnClose13ComboxComComCustType14CheckBoxChkChkRun15RadioButtonRbtnRbtnRun16DateTimePickerDtpDtpInvStart17TreeViewTrvTrvList18PopupMenuPmuPmuCheck19MainMe

7、nuMmuMmuMain20MemoMmoMmoText21BitBtnBitnBitnOk22StringGridSgdSgdEmp3.2注释及格式要求注释总是加在程序的需要一个概括性说明或不易理解或易理解错的地方。注释应语言简练、易懂而又准确，所采用的语种首选是中文，如有输入困难、编译环境限制或特殊需求也可采用英文。3.2.1源代码文件的注释1)在文件的头部必须标明程序名称，它所完成的主要功能。2)文件的作者，及完成时间。3)阶段测试结束后，主要修改活动的修改人、时间、简单原因说明列表。4)维护过程中需要修改程序时，

8、应在被修改语句前面注明修改时间和原因说明。计算机源代码编写规范3.2.2函数或过程的注释//==============================================================////建立时间：建立人：//程序功能：//修改时间：修改人：//修改功能：//===========