代码规范(delphi)

《代码规范(delphi)》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、文档名称DELPHI代码规范描述该文裆描述丫在项目开发过程中，开发人员编写代码所应遵循的规范，包桮命名规则，代码结构等货贵人状态文档变更历史:时间修改人描述审核人意见文档路径:目录1编程风格41.1统一编程风格的意义41.2变量命名规则41.3函数命名规则41.4类命名规则51.5常见语句书写规则51.6注释风格71.7缩进与换行：71.8空格与空行7282.1代码优化的意义82.2函数A的代码优化82.3类内的代码优化82.4类之间的代码优化91编程风格1.1统一编程风格的意义•增加开发过程代码的强壮性、可读性、易维护性•减少有经

2、验和无经验开发人员编程所需的脑力工作•为软件的良好维护性打下好的基础•在项目范围内统一代码风格•通过人为以及自动的方式对最终软件应用质量标准•使新的开发人55快速适应项目氛围•支持项目资源的复用：允许开发人员从一个项目区域（或子项目团队）移动到另一个，而不需要重新适应新的子项目団队的氛围•一个优秀而且职业化的开发团队所必需的素质1.2变量命名规则•一般变量命名规则：前缀字母+名词1）全局变量：g+名词表示是全局变量如：gUserlnfo;系统用户变量2）局部变变fi类型简写+名词i:整数类型；s，str:字符串；c:字符串iValu

3、e;整数变量sOldValue或strOldValue;字符串变量realNewValue;实数变B:•常fi命名规则：全部大写，如有多个名词，则用下划线申起来如：WM_USER=12345消息常量APPNAME=‘focustarKBS’字符串常量•类变量命名规则：前缀表明变量的作用域。如：Fxx表示是类的成员变量局部变量不允许和全局变量同名Public或published不允许定义变量•接口变量命名规则：前缀字母1+名词1.3函数命名规则•函数名用首字母大写的英文单词组合表示（如用动词+名词的方法），其屮至少有一个动词。（骆驼式

4、命名法）•应该避免的命名方式：和继承来的函数名一样。即使函数的参数不一样，也尽量不要这么做，除非你想要重载它。只有一个动词组成，如：Save、Update。改成如：SaveValue、UpdateDataSet则比较好•函数参数的命名规则：函数参数应该具行自我描述性，应该能够做到见其名而知其意1.4类命名规则•类名中尽量不要出现下划线。•前缀T开头•接口类命名Tintf开头1.5控件命名规则•命名规则：前缀+名词，名词尽量使用有意义的命名•强制程序中有实际使川意义的控件必须要命名。•常用控件列表前缀缩写类型缩写前缀标签类lbl单文本

5、编辑类edt多文本类mm网格类grid按钮类btn树型类treeTClientDataSetcdsTDataSetProviderdspTDataSourceds•不在列表的控件统一按照cnpack规范1.6单元文件命名规则•窗体命名规则：前缀frm+名词•数据模块命名规则：前缀dm+名词•单元保存命名规则：前缀nnt+名词•工程命名规则：名词，尽量与实际项目名词保持一致•接口单元命名规则：前缀Intf_+名词1.7常见语句书写规则语句提倡的风格ifif(condition)beginstatements;endelsebegins

6、tatements;endforfor(initialization;condition;update)beginstatements;endcasecase()ofvalue1:beginstatements;end;valuel:beginstatements;end;elsebeginstatements;endendwhilewhile(")beginstatements;endtry-exceptTrystatements;excepton(Exceptione)dobeginstatements;end;end;1.8注

7、释风格•注释应该正确、简洁、有重点。•应该写优雅的、可读性良好的代码，而不是为玄妙、晦涩的代码写注释。•原则上应尽量减少程序体内代码的注释，应该保持代码本身的直接可读性。•函数的注释，可以只对public或者重要的private函数进行注解。•对于函数或过程的功能性注释，在函数或过程的申明之前用//形式的注释定义之前用形式的注释。•对于语句块的注释使用//形式的注释，注释前留一个空行，被注释的语句结朿后留一个空行。•对语句的注释使用//形式的注释写在被注释的语句后而，写；之间空至少一格。1.9缩进与换行：•除子函数首次缩进一格外，每

8、次缩进2个空格•语句的长度尽量不要超过屏幕宽度。•;除定义参数外，后而总是换行•Var关键字总是独占一行•if语句的then关键字和if语句在同一行，Begin与end成对，总是独占一行，象这样：•if（••••）then•begin