源代码规范文档

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

1、W.MIS项目源代码规范版本<1.0>文件编号：W.MTS-MN-5生效日期：受控编号：密级：版本：VI.0修改状态：总页数23正文附录编制：IT审核：批准：［注:以下提供的模板用于GET.GEKIT的文档编写。其中包括用方括号括起來并以蓝色斜体（样式JifoBliw）显示的文本,它们用于向作者提供指导,在发布此文档之前应该将其删除。按此样式输W.MIS项目源代码规范版本<1.0>文件编号：W.MTS-MN-5生效日期：受控编号：密级：版本：VI.0修改状态：总页数23正文附录编制：IT审核：批准：［注:以下提供的模板用于GET.GEKIT的文档编写。其中包括用方括号括起來并以蓝色斜体（样式J

2、ifoBliw）显示的文本,它们用于向作者提供指导,在发布此文档之前应该将其删除。按此样式输入的段落将被口动设置为普通样式（样式-BodyText）。］文档修改记录修改编号修改页码及条款修改人审核人修改日期生成版本1目录2.目的53.源程序书写规范52.1通用源代码格式规则51.1缩进52.1.2边距52.1.3begin...end语句52.1.4注释52ObjectPascal语句格式语句书写规范与用法51括号52.2.2保留字和关键字62.2.3过程和函数62.4变量72.2.5类型72.2.6语句82.7结构化异常处理9命名规范103.1过程(Procedure)与函数(Functio

3、n)103.1.1命名101.2形参101.3命名冲突103.2常量(Constants)和变量(Variable)113.1常量112变量113.3类型(Type)113.3.1一般类型113.3.2构造类型113.3类类型(Class)123.3.4元件类型133.3.5窗体与对话框类型153.3.6数据模块类型173.4文件171项目文件173.4.2窗体文件173.4.3数据模块文件174.4.4远程数据模块文件184.5单元文件183.5内置汇编194.源程序文档注释规范205.1单元文件注释文档格式202.函数(属性)的注释文档格式222.函数每一步处理的注释224修改代码部分的注

4、释231新增代码彳J2删除代码行2323234.4.3修改代码彳J代码规范2..目的本文档主要是为员提供一个源代码卩写标准，以及程序和文件的命名标准，使他们在编程时有一致格式可遵循。这样，每个编程人员编写的代码能够被其他人理解。3..源程序书写规范2.1通用源代码格式规则2.1.1缩进缩进就是每级间有两个空格。不要在源代码屮放置制表符。这是因为，制表符的宽度随着不同的设置和代码管理实用程序(打印、文档及版本控制等)1佰不同。通过使用ToolslEnvironment菜单，在EnvironmentOptions对话框的General页上，不要选屮UseTabCharacter和OptionalF

5、ill复选框，这样，制表符就不会被保存。2.1.2边距边距设置为8()个字符。源代码一般不会因写一个单词而超过边距，但本规则比较灵活。只要可能，长度超过一行的语句应当用逗号或运算符换行。换行后，应缩进两个字符。2.1.3begin...end语句begin语句必须单独占一行。例如，下面笫一行是错谋的，而第二行止确：fori:=0to10dobegin//错,begin与for在同一行fori:=()to1()do//对,begin在另外一行中begin本规则的一个特殊情况是，当begin为else语句的一部分时，例如：ifsomestatement=thenbegin•••endelsebeg

6、inSomeOtherStatement;end,注意：end语句总单独一行。当begin不为else语句的一部分时，相应的end语句与begin语句的缩进量相同。2.1.4注释有关注释要求，请参阅源程序文档注释规范。4..2ObjectPascal语句格式语句书写规范与用法4.1扌舌号在左括号与下一字符之间没有空格。同样，右括号与前一字符也没有空格。下面的例子演示了正确与不正确的空格。CallProc(Aparameter);//错!CallProc(Aparameter);H正确不要在语句中包含多余的括号。在源代码中，括号只有在确实需要时才使用。下面的例子演示了正确与不正确用法：if(1

7、=42)then//错,括号是多余的if(1=42)or(J=42)thenH正确，必须使用括号2.2.2保留字和关键字ObjectPascal语言的保留字和关键字总是完全的小写。下面是Delphi5保留字列表:andarrayasasmbegincaseclassconstconstructordestructordispinterfacedivdodowntoelseendexceptexpo