欢迎来到天天文库
浏览记录
ID:33088655
大小:217.50 KB
页数:14页
时间:2019-02-20
《windows环境相爱delphi编程规范》由会员上传分享,免费在线阅读,更多相关内容在应用文档-天天文库。
1、WINDOWS环境下编程规范基于Delphi的标准华腾软件系统有限公司2002.3.29第14页Windows环境编程规范文档异动历史版本号日期说明作者/审阅V1.0.02002/3/292002/4/4初稿第二稿许彤慧审阅:杨文彬、陈丽萍、曾曙峰、李聪明、魏海波第14页基本要求3可读性要求3结构化要求4正确性与容错性要求4可重用性要求4命名规则5用户界面8注释使用规范10数据说明及定义规范12其他书写规范13提示信息规范13第14页WINDOWS环境下编程规范基于delphi的标准基本要求1.程序结构清析,简单易懂,单个函数的程序行数最好不超过100行。2.打算
2、干什么,要简单,直接了当,代码精简,避免垃圾程序。(需要按详细设计方案)3.尽量使用标准库函数和公共函数。4.不要随意定义全局变量,尽量使用局部变量。(全局变量由专人专管)5.表达式使用括号以避免二义性可读性要求1.可读性第一,效率第二。2.保持注释与代码完全一致。(定时抽查)3.每个源程序文件,都有文件头说明,说明规格见规范。(推荐使用英文)4.每个函数,都有函数头说明,说明规格见规范。(推荐使用英文)5.主要变量(结构、联合)定义或引用时,注释能反映其含义。(对于难以描述的变量可以使用中文)6.常量定义有相应说明。7.处理过程的每个阶段都有相关注释说明。8.在
3、典型算法前都有注释。9.利用缩进来显示程序的逻辑结构,缩进量一致并以Tab键为单位,定义Tab为4个空格10.循环、分支层次不要超过五层。11.注释可以与语句在同一行,也可以在上行。12.空行和空白字符也是一种特殊注释。13.一目了然的语句不加注释。14.注释的作用范围可以为:定义、引用、条件分支以及一段代码。15.不要轻易用条件分支去替换逻辑表达式。16.不要用晦涩的语句结构化要求1.禁止出现两条等价的支路。2.少用GOTO语句。3.用IF语句来强调只执行两组语句中的一组。禁止ELSEGOTO。第14页1.用CASE实现多路分支。2.避免从循环引出多个出口。3.
4、函数只有一个出口。4.不使用条件赋值语句。5.避免不必要的分支。正确性与容错性要求1.程序首先是正确,其次是优美2.无法证明你的程序没有错误,因此在编写完一段程序后,应先回头检查。3.改一个错误时可能产生新的错误,因此在修改前首先考虑对其它程序的影响。4.所有变量在调用前必须被初始化。5.对所有的用户输入,必须进行合法性检查。(包括日期、金额、下拉框中的内容、费率等)6.不要比较浮点数的相等,如:10.0*0.1==1.0,不可靠7.程序与环境或状态发生关系时,必须主动去处理发生的意外事件,如文件能否逻辑锁定、打印机是否联机等。8.单元测试也是编程的一部份,提交联
5、调测试的程序必须通过单元测试。可重用性要求1.重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类或公共函数。(由专人控制,编码说明通过EMAIL发放)2.公共控件或类或函数应考虑OO思想,减少外界联系,考虑独立性或封装性。命名规则1.宏定义命名宏定义的命名由大写英文字母、数字和下划线组成,各单词之间用下划线“_”分开。宏定义的名字原则上应与后台server保持一致,以下为符合规范的宏定义名字://communicationstatusCOMM_DISCONN=0;COMM_CONN=1;COMM_RUNNING=2;2.变量命名基本规则第14页程序中所有变
6、量的命名遵循以下的组成规则:<作用域名>+<类型前缀名>+<自定义名>其中作用域名区分局部变量和全局变量;类型前缀名是单个或几个不同基本数据类型的组合,基本数据类型前缀名在以下各节作说明;变量的自定义名字由英文字母和数字组成,使用大小写字母区分各单词,首字符为大写英文字母。整个变量名的总长度不设限制(只要符合编译器的规定就行)。1.基本数据类型的前缀名ã整型变量前缀名(包括Shortint,Smallint,Longint,Int64,Byte,Word,andLongword.)整型(integer,int64)变量的类型名为‘i’,例如:iIntegerVar
7、:integer;ã单个字符型变量前缀名单个字符型(char,pchar)变量的类型名为‘c’,例如:cCharVar:char;ã字符串变量前缀名字符串变量的类型名为‘s’,例如:sStringVar:string;ã布尔型变量前缀名布尔型变量的类型名为‘b’,例如:bBooleanVar:boolean;2.其他数据类型变量的前缀名ã枚举型变量前缀名枚举型(enum)变量的类型名为‘e’,例如:typeeEnumVar=(“Sun”,“Mon”,“Tue”,“Wed”,“Thu”,“Fri”,“Sat”);ã数组型变量前缀名数组型变量是在其基本数据类型名后加上
8、字母‘a’
此文档下载收益归作者所有