Delphi编码指南good课案

Delphi程序员代码编写标准指南Delphi程序员代码编写标准指南(仅供参考)目录一、序言二、通用源代码格式规则2.1缩格2.2页边空格2.3Begin⋯End配对三、ObjectPascal3.1括号3.2保留字和关键字3.3过程和函数（例程）3.3.1命名/格式化3.3.2形式参数3.3.2.1格式化3.3.2.2命名3.3.2.3参数的排序3.3.2.4常量参数3.3.2.5名称的冲突3.4变量3.4.1变量的命名和格式3.4.2局部变量3.4.3全局变量的使用3.5类型3.5.1大写约定3.5.1.1浮点指针类型3.5.1.2枚举类型3.5.1.3变数和ole变数类型3.5.2结构类型3.5.2.1数组类型3.5.2.2记录类型3.6语句3.6.1if语句3.6.2case语句3.6.2.1一般性话题3.6.2.2格式3.6.3while语句3.6.4for语句3.6.5repeat语句3.6.6with语句3.6.6.1一般话题第1页(共30页)Delphi程序员代码编写标准指南3.6.6.2格式3.7结构异常处理3.7.1一般话题3.7.2try⋯finally的使用3.7.3try⋯except的使用3.7.4try⋯except⋯else的使用3.8类类型3.8.1命名和格式3.8.2域3.8.2.1命名/格式3.8.2.2可视化3.8.3 方法 快递客服问题件处理详细方法山木方法pdf计算方法pdf华与华方法下载八字理论方法下载 3.8.3.1命名/格式3.8.3.2使用静态的方法3.8.3.3使用虚拟/动态的方法3.8.3.4使用抽象的方法3.8.3.5属性存取方法3.8.4属性3.8.4.1命名/格式3.8.4.2使用存取的方法四、文件4.1 工程 路基工程安全技术交底工程项目施工成本控制工程量增项单年度零星工程技术标正投影法基本原理 文件4.1.1命名4.2窗体文件4.2.1命名4.3数据模板文件4.3.1命名4.4远端数据模板文件4.4.1命名4.5Unit文件4.5.1通用Unit结构4.5.1.1unit的名字4.5.1.2uses子句4.5.1.3interface部分4.5.1.4implementation部分4.5.1.5initialization部分4.5.1.6finalization部分4.5.2窗体单元4.5.2.1命名4.5.3数据模板单元4.5.3.1命名4.5.4一般目的单元4.5.4.1命名4.5.5构件单元第2页(共30页)Delphi程序员代码编写标准指南4.5.5.1命名4.6文件头五、窗体和数据模板5.1窗体5.1.1窗体类型命名标准5.1.2窗体实例命名标准5.1.3自动创建窗体5.1.4模式窗体实例化函数5.2数据模板5.2.1数据模板命名标准5.2.2数据模板实例命名标准六、包6.1使用运行包和设计包的比较6.2文件命名标准七、构件7.1用户自定义构件7.2构件单元7.3使用注册单元7.4构件实例命名约定7.5构件的前缀7.5.1Standard页7.5.2Additional页7.5.3Win32页7.5.4System页7.5.5Internet页7.5.6DataAccess页7.5.7DataControls页7.5.8DecisionCube页7.5.9QReport页7.5.10Dialogs页7.5.11Win3.1页7.5.12Samples页7.5.13ActiveX页7.5.14Midas页八、注释8.1文件头注释8.2函数或过程头注释8.3块注释8.4关键语句注释九、其他9.1数据库相关命名原则9.2Delphi系统常量9.3基本提示信息9.4基本编程 要求 对教师党员的评价套管和固井爆破片与爆破装置仓库管理基本要求三甲医院都需要复审吗 第3页(共30页)Delphi程序员代码编写标准指南一、序言本文档详述了在Delphi4开发者指南下进行编程的代码编写标准。在Delphi4开发者指南中包含本文档的目的在于阐述一种方法，通过该方法，开发小组可以在他们所编写的代码中保持一贯的风格。这样做的目的是使在开发小组中的每一个程序员都可以明白其他程序员的代码。这有助于提高代码编写的可读性和使用的一贯性。本文档并不意味着包含了所有存在于代码中的标准。但是，它的内容已足够帮你起个好头。你可以自由的增加修改这些标准来满足你的需要。但我们不赞成你偏离这些由Borland开发人员所使用的标准太远。我们推荐这么做是因为一旦有新的程序员加入到你的开发小组中，而他们最喜欢和最熟悉的是Borland的标准。与大多数代码标准文档一样，本文档也会根据需要进行改动。因此，你可以到www.xapware.com/ddg中找到最新的更新版本。本文档不包括用户接口标准。本文档是独立的但也是同样重要的。已经有足够的第三方书籍和Microsoft文档包括了另外一些指导方针，这里不再赘述这些信息，但我们会指引你到MicrosoftDevelopersNetwork和其他一些资源，在那儿可以找到你所需的信息。二、通用源代码格式规则2.1缩格为增加可读性，依照程序的逻辑关系（循环语句、选择语句等），采用锯齿状排版格式，缩格是指在每一级有两个空格。不要在源代码中保留tab字符，这是因为tab字符会随着不同用户的不同设置和不同的资源管理工具（打印、文档、版本控制等）而代 表 关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf 不同的宽度。你可以通过关闭Environment选项对话框中Editor页上的“Usetabcharacter”和“Optimalfill”检查框（通过Tools|Environment）来禁止保存tab字符。2.2页边空格代码行的左右边界一般会被设置成80字符宽。通常，源码不会超出这个边界，但这个方针会有一些弹性。不管是否有可能，那些超出到另一行的语句会在一个逗号或其他操作符之后与前面的语句相连。当一个语句被打断相连时，它应比原来的那一行语句缩进两个字符。2.3Begin⋯End配对Begin子句应写在独立的一行。例如，下面第一行是错误的写法而第二行是正确的。forI:=0to10dobegin//错误，begin同for在同一行forI:=0to10do//正确，begin出现在独立的一行begin这个规则的例外是当begin子句的出现是作为一个else子句的一部分－参考例子：第4页(共30页)Delphi程序员代码编写标准指南ifsomestatementthenbegin⋯endelsebeginsomeOtherStatement;end;end语句总是出现在独立的一行。当begin语句不是一个else子句的一部分时，相应的end语句永远缩进到与begin部分相对应的位置。三、ObjectPascal3.1括号不要在括号与括号之间的字符中间留下空格。下面的例子示范了错误的与正确地使用括号中的空格：CallProc(Aparameter);//错误CallProc(Aparameter);//正确不要在一个语句中使用不必要的括号。括号只应在源代码中需要的地方使用。以下的例子示范了错误和正确的使用：if(I=42)then//错误－多余的括号if(I=42)or(J=42)then//正确－需要括号3.2保留字和关键字ObjectPascal保留字和关键字永远是全部小写。3.3过程和函数（例程）3.3.1命名/格式化例程的名字通常应该以大写的字母开头并且中间错落分明以便于增强其可读性。下面是一个格式不正确的过程名称：procedurethisisapoorlyformattedroutinename;下面是一个合适的大小写过程名称的例子：procedureThisIsMuchMoreReadableRoutineName;过程的名称应该同它的内容相符。一个会导致某种行为的过程应以动词开头。例如：第5页(共30页)Delphi程序员代码编写标准指南procedureFormatHardDrive;一个用于设置输入参数的过程应以单词set作为前缀，例如：procedureSetUserName;一个用来取得某个值的过程应以单词get作为前缀，例如：procedureGetUserName:string;3.3.2形式参数3.3.2.1格式化如果有的话，相同类型的形参应合并在一个语句中：procedureFoo(Param1,Param2,Param3:Integer;Param4:string);3.3.2.2命名所有形参的名字应是十分符合它们所代表的意义，特别是应该以传送到例程中的标志符的名称为基础。一个好的参数名称应以字符A为前缀－例如：procedureSomeProc(AuserName:string;AuserAge:integer);“A”前缀按约定表示该参数的名称是与类类型中的一个属性或域的名称相对应的。3.3.2.3参数的排序下面的形参的顺序重点说明了注册者调用约定调用的好处。－最常用的参数应放在第一位，其它的参数应按从左到右的顺序排列。－输入参数列表应放在输出参数列表的左边。－将通用的参数放在特殊参数的左边，例如：procedureSomeProc(Aplanet,AContinent,Acountry,Astate,Acity)－排序有可能有些例外，比如事件的处理。类型为TObject的Sender参数经常放在第一位。3.3.2.4常量参数当一个参数为记录型、数组类型、ShortString、或接口类型并且在例程中不被改变时，这些参数应做上常量标记。这样做会让编译器更加有效率的产生有关这些不改变的参数的代码。而例程中另外一些非变参数也可常量来传送。尽管这样做没有产生任何效果和提高效率，这将会给调用例程的使用者提供更多的信息。第6页(共30页)Delphi程序员代码编写标准指南3.3.2.5名称的冲突当使用拥有两个名称相同的例程的两个单元时，如果你调用该例程时，在uses子句中排在后面的单元中的例程将会被调用。为了解决这种“在uses子句上的模糊”冲突，要在调用该例程时写上相关的单元的前缀，例如：sysUtile.FindClose(SR);或windows.FindClose(Handle);3.4变量3.4.1变量的命名和格式变量的命名应以使用它们的目的相符循环控制变量应采用一个单独的字符作为名字，比如I，J，或K，也可以采用更加有意义的名字，比如UserIndex。逻辑变量的名字应能充分表达准确的真或假的意思。3.4.2局部变量一个过程中的局部变量应遵循所有其它变量的使用和命名约定。临时变量的取名应合理。如果必须的话，在一进入例程就应初始化局部变量。局部的AnsiString变量会自动初始化为一个空的字符串。局部接口和派分接口类型变量将会自动初始化为nil，并且局部变数和ole变数类型变量会自动初始化为Unassigned3.4.3全局变量的使用使用全局变量是不推荐的。但是，在某些时候还是必须使用，而且它们也只应在必须使用的时候才使用。在这种时候，你应努力只在一段上下文范围内使用全局变量。例如，一个全局变量只应在一个单元的implemntation部分内是全局的。如果打算在多个单元类使用全局数据，你应将它们移到一个公共的单元中然后被其它所有单元使用。全局变量可以在var子句中直接初始化为一个值。记住，所有的全局数据会自动初始化为0,因此不要将全局变量初始化为一个“空”值比如0、nil、’’、Unassigned、等等。这样做的一个理由是因为零－初始化的全局数据在exe文件中不会占据任何空间。零－初始化数据被存储在一个虚拟的数据段，它在应用程序启动后被分配在一段内存中。非零－初始化的全局数据在硬盘的exe文件占用空间。第7页(共30页)Delphi程序员代码编写标准指南3.5类型3.5.1大写约定如果类型的名字是保留字，那么它应全部小写。Win32API类型通常全部大写，并且你必须遵循在Windows.pas或其他API单元中的详细类型名称的约定。对于其他变量名字，地一个字母应为大写，而其他字母应错落有致。下面是一些例子：varMyString:string;//保留字WindowHandle:HWND;//Win32API类型I:Integer;//在System单元中引进的类型标识符3.5.1.1浮点指针类型不推荐使用Real类型，因为它的存在只是为了向前兼容早期的Pascal代码。在通常情况下用Double来实现浮点指针的需要。并且，Double对处理器和总线而言是做了最优化处理的，它也是IEEE中定义的标准数据格式。只有当需要的范围超出Double所定义的范围时才使用Extended。Extended是intel定义的类型且在Java中不支持。只有当浮点指针变量的实际字节大小有其意义时才使用Single。（比如当使用另一种语言的DLLs时）。3.5.1.2枚举类型枚举类型的名字需符合使用该类型的目的。该类型的名字需以字符T为前缀，以表明这是一个类型。枚举类型中的标识符列表必须包含两个或三个字符的前缀来对应于该枚举类型的名字－例如：TsongType=(stRock,stClassical,stCountry,stAlternative,stHeavyMetal,stRB);一个枚举类型的实例的名字应与不要前缀的枚举类型（SongType）相同，除非有更好的原因来赋予该变量更特殊的名字，比如：FavoriteSongType1,FavoriteSongType2等等。3.5.1.3变数和ole变数类型通常不建议使用变数和Ole变数类型。但在只有运行时刻才能知道数据类型的程序中必须使用该类型，这种情形多出现在COM和数据库开发中。Ole变数使用在以COM为基础的编程中例如自动化和ActiveX控制，而变数使用在非COM的编程中，这是因为变数可以十分有效地存储本地Delphi字符串（同一个字符串变量一样），但Ole变数会将所有的字符串转换为Ole字符串（WideChar字符串）并且并不实例运算－它们永远拷贝。第8页(共30页)Delphi程序员代码编写标准指南3.5.2结构类型3.5.2.1数组类型数组类型的名字需符合它们使用的目的。该类型的名字必须加以前缀T。如果须声明该数组类型的指针，那么该指针需加以前缀P而且应立即声明在该数组声明的前面。例如：typePCycleArray=^TCycleArray;TCycleArray=array[1⋯100]ofinteger;在实际应用中，数组的变量实例的名称应是其类型的名字去掉前缀T。3.5.2.2记录类型记录类型的名字应符合使用它们的目的。其类型的声明应加以前缀T。如果要声明该记录类型的指针，就应加以前缀P并且应紧靠在类型声明的前面声明。例如：typePEmployee=^TEmployee;TEmployee=recordEmployeeName:string;EmployeeRate:Double;end;3.6语句3.6.1if语句在if/then/else语句中最常发生的行为应放在then子句中，而其它发生可能性较小的行为应放在else子句中。if语句，在这种情形下应用多个if语句来判断各种可能。不要使用if嵌套超过五级深度。应使代码编写得更加清晰、明了。不要在if语句中使用不必要的圆括号。如果在if语句中有多个条件需测试，这些条件应按计算强度由少到多的顺序从左到右排列。这样做能使编译器在编译代码时获得布尔估算逻辑的捷径，从而使你的代码获得最佳的优化。举例来说，如果条件1快过条件2，而条件2快过条件3，那么在if语句中的排列应是：if条件1and条件2and条件3then第9页(共30页)Delphi程序员代码编写标准指南3.6.2case语句3.6.2.1一般原则在一个case语句中的各个独立的单元应以数字或字母顺序排列。每一个case单元的动作行为应保持简单而不应该超过四到五行代码。如果所要执行的动作过于复杂应采用独立的过程或函数。Case语句中的else子句只有当需要缺省行为或处理错误时才使用。3.6.2.2格式case语句应遵循其它结构的缩格和命名约定。3.6.3while语句在一个while语句中不建议使用exit过程来跳出循环，尽量仅使用循环条件来跳出循环。在一个while循环中所用的初始化代码应紧靠在进入while循环前面出现而不要被其它不相关的语句隔开。任何结束后的处理应在循环之后立即进行。3.6.4for语句for语句只有当循环次数已知的情况下才能取代while语句使用。3.6.5repeat语句repeat语句的使用同while语句一样，并且遵循同样的通用方针。3.6.6with语句3.6.6.1一般原则with语句应避免过多使用，并且有很多需注意的地方。避免过度使用with语句并且在with语句中小心使用多个对象、记录等等。例如：withRecord1,Record2do这些代码会使程序员感到困惑并难以发现问题所在。第10页(共30页)Delphi程序员代码编写标准指南3.6.6.2格式with语句遵循本文档所说明的命名约定和缩格的格式规则。3.7结构异常处理3.7.1一般原则异常的处理大量地使用在错误纠正和资源保护方面。这就是说一旦资源被分配，一个try⋯finally必需加以使用来保证该资源被正确的释放。这种异常的保护也是指在一个单元的initializition/finalization或一个对象的constructor/destructor中进行资源的分配和释放。3.7.2try⋯finally的使用任何情形下，每一次的分配都应跟随一个try⋯finally。举例来说，下面的代码会造成可能的错误：SomeClass1:=TsomeClass.Create;SomeClass2:=TsomeClass.Create;try{dosomecode}finallySomeClass1.Free;SomeClass2.Free;end;更安全更合适的分配过程应是：SomeClass1:=TSomeClass.Create;trySomeClass2:=TsomeClass.Create;try{dosomecode}finallySomeClass2.Free;end;finallySomeClass1.Free;end;3.7.3try⋯except的使用只有当在异常被触发而你想执行一些任务时才使用try⋯except。通常，没有必要为了只是简单地在屏幕上显示一个错误信息而使用try⋯except语句，因为这会被第11页(共30页)Delphi程序员代码编写标准指南Application对象自动执行。如果你想在except子句中执行完一些任务之后调用缺省的异常处理，使用raise来重新触发异常到下一个句柄。3.7.4try⋯except⋯else的使用try⋯except中的else子句不建议使用，因为它会打断所有的异常包括那些没有准备的异常。3.8类类型3.8.1命名和格式类类型的名称应符合使用它们的目的。类型名字应加以前缀T以表明这是一个类型的定义－例如：typeTcustomer=class(TObject)类型的实例通常是没有前缀T的类型的名字－例如：varCustomer:Tcustomer;注意：查阅“构件类型的命名标准”来获得更多有关构件命名的信息。3.8.2域3.8.2.1命名/格式类的域名遵循与变量标识符同样的约定除了它们应以F为前缀，来表明这是一个域的名称。3.8.2.2可视化所有的域都必需是私有的。想在类的范围之外存取域得通过属性来使用。3.8.3方法3.8.3.1命名/格式方法的命名应遵循本文档中有关过程和函数的约定叙述。第12页(共30页)Delphi程序员代码编写标准指南3.8.3.2使用静态的方法如果使用一个静态的方法，那么该方法就不能被该类的后代类所继承。3.8.3.3使用虚拟/动态的方法如果你打算该类的方法能被后代的类所继承就得使用虚拟的方法。只有在该方法有多个继承时（直接的或间接的）才使用动态的方法。例如，一个类类型包含一个可继承的方法，而100个后代类要继承这种方法，那么这个方法就会动态地产生为100个后代类使用的内存。3.8.3.4使用抽象的方法中使用抽象的方法。3.8.3.5属性存取方法现在类的private或protected部分。属性存取方法的命名应遵循过程和函数的约定规则。读取存取方法（方法读取器）必需以单词Get为前缀。写入存取方法（方法写入器）必需以单词Set为前缀。方法写入器的参数的名字应为Value，并且它的类型应是它所操作的属性的类型。例如：TSomeClass=class(TObject)privateFsomeField:Integer;protectedfunctionGetSomeField:Integer;procedureSetSomeField(Value:Integer);publicpropertySomeField:IntegerreadGetSomeFieldwriteSetSomeField;end;3.8.4属性3.8.4.1命名/格式除去解释符F。数。3.8.4.2使用存取的方法第13页(共30页)Delphi程序员代码编写标准指南四、文件4.1工程文件4.1.1命名工程文件应取个描述性的名字。例如，Delphi4开发者指南错误管理器的工程名字是：DDGBugs.dpr。一个有关系统信息的程序的名字就应象SysInfo.dpr。4.2窗体文件4.2.1命名可以描述使用该窗体的目的，并加以后缀Frm。例如，一个“关于”的窗体的文件名应是AboutFrm.dpr。主窗体的文件名应是MainFrm.dpr。4.3数据模板文件4.3.1命名使用该数据模板的目的，它的名称应加以两个字符的后缀DM。例如，自定义数据模板的文件名字应为CustomersDM.dfm。4.4远端数据模板文件4.4.1命名表示使用该远端数据模板的目的，它的名称应加以三个字符的后缀RDM。例如，自定义远端数据模板的文件名字应为CustomersRDM.dfm。4.5Unit文件4.5.1通用Unit结构4.5.1.1unit的名字Unit文件应取一个可描述性的名字。例如，包含应用程序主窗体的单元应叫做MainFrm.pas。第14页(共30页)Delphi程序员代码编写标准指南4.5.1.2uses子句interface部分的uses子句应包含在interface部分中的代码所需要的单元。去掉那些Delphi可以自动加入到程序中的单元。implementation部分的uses子句应只包含在implementation部分中的代码所需要的单元的名字。去掉不必要的单元。4.5.1.3interface部分interface部分应包含只那些其它单元所需要存取类型的定义、变量、过程/函数的预定义等等。否则，就应放在implementation部分定义。4.5.1.4implementation部分implementation部分应包含那些只在本单元中私用的类型定义、变量、过程/函数定义等等。4.5.1.5initialization部分不要在initialization部分放入耗时长的代码，这将使程序的第一个界面出现得比较缓慢。4.5.1.6finalization部分Initialization部分所分配的任何资源。4.5.2窗体单元4.5.2.1命名单元文件应拥有与它所对应的窗体文件同样的名称。例如，“关于”窗体的单元名称应为AboutFrm.pas，而主窗体的单元名称应为MainFrm.pas。4.5.3数据模板单元4.5.3.1命名单元文件应拥有与它所对应的数据模板文件同样的名称。例如，一个自定义数据模板单元的名称应为CustomersDM.pas。第15页(共30页)Delphi程序员代码编写标准指南4.5.4一般目的单元4.5.4.1命名的目的。例如，一个实用程序单元取名为BugUtilities.pas。一个包含全局变量的单元取名为CustomerGlobals.pas。注意，该单元的名字不能与它的工程中所使用的所有包中的单元的名字相同。不赞成使用一般的或通用的单元名字。4.5.5构件单元4.5.5.1命名要永远同工程在不同的目录。单元名字应同它们的内容相符。注意：查阅“用户定义的构件”部分来获得更多有关构件命名标准的信息。4.6文件头含以下信息：｛版权⋯著作的年、月、日⋯}五、窗体和数据模板5.1窗体5.1.1窗体类型命名标准。类型定义应加以前缀T。前缀后面跟随着描述性的名字。最后，应加以Form后缀来描述名字。例如，一个“关于”的窗体的类型的名字应为：TAboutFrom=class(TForm);主窗体的定义为：第16页(共30页)Delphi程序员代码编写标准指南TMainForm=class(TForm);一个用户接入窗体的名字应象：TCustomerEntryForm=class(TForm);5.1.2窗体实例命名标准T的相应类的名字。例如，对应于前面窗体类型而言，其实例的名字应为：类型名称实例名称TAboutFormAboutFormTMainFormMainFormTCustomerEntryFormCustomerEntryForm5.1.3自动创建窗体工程选项对话框中的自动创建列表中移走。查阅以下部分来获得更多的信息。5.1.4模式窗体实例化函数体，并释放窗体。该函数应返回窗体的模式结果。该函数要传递的参数应遵循本文档指定的“参数传递”标准。通过这种方式封装的函数性有助于代码的再利用和维护。单元中移走，并在窗体实例的函数中进行本地式地定义。注意，这就意味着该窗体必需从工程/选项对话框中的自动创建列表中剔除。参考本文档后面的“自动创建窗体”。例如，下面的单元展示了在GetUserData窗体中的一个函数。unitUserDataFrm;interfaceuseswindows,Messages,SysUtils,Classes,Graphics,Controls,Forms,Dialogs,StdCtrls;typeTUserDataForm=class(TForm)edtUserName:TEdit;edtUserID:TEdit;private{Privatedeclarations}public{Publicdeclarations}end;functionGetUserData(varaUserName：String;varaUserID:Integer):第17页(共30页)Delphi程序员代码编写标准指南Word;implementation{$R*.DFM}functionGetUserData(varaUserName:String;varaUserID:Integer):word;varUserDataForm:TuserDataForm;beginUserDataForm:=TuserDataForm.Create(Application);tryUserDataForm.Caption:=‘GettingUserData’;Result:=UserDataForm.ShowModal;if(Result=mrOK)thenbeginaUserName:=UserDataForm.edtUserName.Text;aUserID:=StrToInt(UserDataForm.edtUserID.Text);end;finallyUserDataForm.Free;end;end;end.5.2数据模板5.2.1数据模板命名标准数据模板的取名要符合使用该数据模板的目的。类型的定义应加以前缀T，后面紧接着描述性的名字，最后要加以后缀单词“DataModule”。例如，一个自定义的数据模板有时候应该象：TCustomerDataModule=class(TDataModule)一个命令式的数据模板的名字应象：TOrdersDataModule=class(TDataModule)5.2.2数据模板实例命名标准数据模板实例的名称应是对应不带前缀T的类型的名称。例如，对于前面的窗体类型而言，其实例的名称应为：类型名称实例名称TCustomerDataModuleCustomerDataModuleTOrdersDataModuleOrdersDataModule第18页(共30页)Delphi程序员代码编写标准指南六、包6.1使用运行包和设计包的比较运行时刻的包应只包含其它构件包所要求的单元或构件。另外，包含属性/构件编辑器和其它只为设计的代码应放入到设计时刻包中。注册单元应放在设计包中。6.2文件命名标准包的名称应依照下面的例子：“iiilibvv.pkg”－设计时刻包“iiistdvv.pkg”－运行时刻包字符“iii”表示一个3字符标识前缀。这个前缀用来表明公司、个人或其它有标识意义的实体。字符“vv”表示为该包想要对应Delphi某个版本的包的版本号。注意，包的名字中包含“lib”或“std”的意思是表明这是一个设计时刻包还是一个运行时刻包。如果既是设计时刻包又是运行时刻包，该文件的命名是同上面一样的，例如，为Delphi4开发者指南做的包的名称应为：DdgLib40.pkg–设计时刻包DdgStd40.pkg–运行时刻包七、构件7.1用户自定义构件在标准构件中命名出来的构件的名称同在“类类型”部分定义中的一样定义成一个类类型，不同的是它们有一个3字符的指示前缀，这个前缀可以表示公司、个人或其它实体。例如，一个为Delphi4开发者指南编写的时钟构件的名称定义为：TddgClock=class(TComponent)注意，那三个前缀字符是小写的。7.2构件单元构件单元应只包含一个主要的构件，一个主要的构件是指出现在构件栏中的构件。主要第19页(共30页)Delphi程序员代码编写标准指南构件的辅助构件/对象应放入到同一个单元中。7.3使用注册单元构件的注册过程应从构件本身的单元中剔除，并放入到一个独立的单元中。这个注册单元可以用来注册任何构件、属性编辑器、构件编辑器、专家器等。构件的注册只应在设计时刻包中进行，注册单元应包含在设计时刻包中而不应放在运行时刻包中。推荐使用的注册单元的名称是：XxxReg.pas上面的3个前缀字符“Xxx”用来表示一个公司、个人或任何其它的实体。例如，在Delphi4开发者指南中的注册单元的名称应为DdgReg.pas。7.4构件实例命名约定所有的构件都应取个描述性的名称。在设计构件类型时应设计一个小写的前缀。使用前缀而不使用后缀的原因是在搜寻时，在对象检查器和代码探索器中搜寻构件的名字比搜寻构件的类型更容易实现。7.5构件的前缀以下构件的前缀可以用来设计Delphi4中的标准构件。请在此列表中加入第三方构件的前缀。7.5.1Standard页前缀构件TMainMenupmTPopupMenummiTMainMenuItempmiTPopupMenuItem前缀构件lblTLabeledtTEditmemTMemobtnTButtoncbTCheckBoxrbTRadioBoxlbTListBoxcbTComboBoxscbTScrollBargbTGroupBoxrgTRadioGrouppnlTPanel第20页(共30页)Delphi程序员代码编写标准指南clTCommandList7.5.2Additional页bbtnTBitBtnsbTSpeedButtonmeTMaskEditsgTStringGriddgTDrawGridimgTImageshpTShapebvlTBevelsbxTScrollBoxclbTCheckListboxsplTSplitterstxTStaticTextchtTChart7.5.3Win32页tbcTTabControlpgcTPageControlilTImageListreTRichEditthrTTrackBarprbTProgressBarudTUpDownhkTHotKeyaniTAnimatedtpTDateTimePickertvTTreeViewlvTListViewhdrTHeaderControl前缀构件stbTStatusBartlbTToolBarclbTCoolBar7.5.4System页tmTTimerpbTPaintBoxmpTMediaPlayerolecTOleContainer第21页(共30页)Delphi程序员代码编写标准指南ddccTDDEClientItemddciTDDEClientItemddscTDDEServerConvddsiTDDEServerItem7.5.5Internet页cskTClientSocketsskTServerSocketwbdTWebDispatcher ppt 关于艾滋病ppt课件精益管理ppt下载地图下载ppt可编辑假如ppt教学课件下载triz基础知识ppt PageProducertpTQueryTableProducerdstpTDataSetTableProducernmdtTNMDayTimenecTNMEchonfTNMFingernftpTNMFtpnhttpTNMHttpnMsgTNMMsgnmsgTNMMSGServnntpTNMNNTPnpopTNMPop3nuupTNMUUProcessorsmtpTNMSMTPnstTNMStrmnstsTNMStrmServntmTNMTimenudpTNMUdppskTPowerSockngsTNMGeneralServerhtmlTHtmlurlTNMUrlsmlTSimpleMail7.5.6DataAccess页前缀构件dsTDataSourcetblTTableqryTQueryspTStoredProcdbTDataBasessnTSession第22页(共30页)Delphi程序员代码编写标准指南bmTBatchMoveusqlTUpdateSQL7.5.7DataControls页dbgTDBGriddbnTDBNavigatordbtTDBTextdbeTDBEditdbmTDBMemodbiTDBImagedblbTDBListBoxdbcbTDBComboBoxdbchTDBCheckBoxdbrgTDBRadioGroupdbllTDBLookupListBoxdblcTDBLookupComboBoxdbreTDBRichEditdbcgTDBCtrlGriddbchTDBChart7.5.8DecisionCube页dcbTDecisionCubedcqTDecisionQuerydcsTDecisionSourcedcpTDecisionPivotdcgTDecisionGriddcgrTDecisionGraph7.5.9QReport页qrTQuickReportqrsdTQRSubDetailqrbTQRBandqrcbTQRChildBandqrgTQRGroupqrlTQRLabel前缀构件qrtTQRTextqreTQRExprqrsTQRSysDataqrmTQRMemoqrrtTQRRichText第23页(共30页)Delphi程序员代码编写标准指南qrdrTQRDBRichTextqrshTQRShapeqriTQRImageqrdiTQRDBMImageqrcrTQRCompositeReportqrpTQRPreviewqrchTQRChart7.5.10Dialogs页对话框构件是由构件封装的真正的窗体，因此，它们应遵循窗体的命名约定。类型已由构件的名称定义。它的实例的名称是Delphi自动生成的类型实例名字去掉数字后缀。举例如下：类型实例名字TOpenDialogOpenDialogTSaveDialogSaveDialogTOpenPictureDialogOpenPictureDialogTSavePictureDialogSavePictureDialogTFontDialogFontDialogTColorDialogColorDialogTPrintSetupDialogPrintSetupDialogTFindDialogFindDialogTReplaceDialogReplaceDialog7.5.11Win3.1页dbllTDBLookupListdblcTDBLookupCombotsTTabSetolTOutlinetnbTTabbedNoteBooknbTNoteBookhdrTHeaderflbTFileListBoxdlbTDirectoryListBoxdcbTDriveComboBoxfcbTFliterComboBox7.5.12Samples页ggTGauge前缀构件cgTColorGridspbTSpinEdit第24页(共30页)Delphi程序员代码编写标准指南speTSpinEditdolTDirectoryOutlinecalTCalendaribeaTIBEventAlerter7.5.13ActiveX页cfxTChartFXvspTVSSpellf1bTF1BookvtcTVTChartgrpTGraph7.5.14Midas页prvTProvidercdsTClientDataSetqcdsTQueryClientDataSetdcomTDCOMConnectionoleeTOleEnterpriseConnectionsckTSocketConnectionrmsTRemoteServermidTmidasConnection第25页(共30页)Delphi程序员代码编写标准指南八、注释一段好的程序应有足够的注释。它大大提高了编码的可读性，使程序更易于维护。一般情况下在编码中应加入文件头注释，函数头注释，块注释（数据块），及关键语句注释。文件头注释和函数头注释与程序代码之间应留有一空行，使编码结构更清晰。8.1文件头注释内容及格式：{******************************************************************************文件名：描述：（说明该文件的主要处理功能）公共函数：（列出所用到的公共函数的类型、函数名及参数）调用模块：（说明所用到的其它模块、对象、函数等，是否对调用模块进行了环境保护）数据库：（列出用到的数据库，何种操作）文件：（列出用到的文件，何种操作）作者：建立日期：XXXX年XX月XX日修改者：修改日期：XXXX年XX月XX日修改内容：（简要说明修改的原因、内容，如改动很大，将改动前的源程序列在文件头注释中）修改者：修改日期：修改内容：（从“修改者”到“修改内容”部分根据修改次数添加）⋯******************************************************************************}8.2函数或过程头注释内容及格式：{******************************************************************************函数名：说明：（说明该函数或过程的主要功能）输入参数：（说明输入参数名称、数据类型、参数功能描述）输出参数：（说明输出参数名称、数据类型、参数功能描述）返回值：（说明返回值的类型、值域，过程没有此项）全局变量：（列出用到的全局变量，取值，是否保护）数据库：（列出用到的数据库，何种操作）文件：（列出用到的文件，何种操作）调用：（列出被调用函数的函数名及参数）作者：第26页(共30页)Delphi程序员代码编写标准指南建立日期：XXXX年XX月XX日修改者：修改日期：XXXX年XX月XX日修改内容：（简要说明修改的原因、内容，如改动很大，将改动前的源程序列在文件头注释中）修改者：修改日期：修改内容：（从“修改者”到“修改内容”部分根据修改次数添加）⋯******************************************************************************}备注：该注释放在所定义的函数或过程的前面8.3块注释用于描述其后的语句或程序段是在做什么工作，也就是解释下面要“做什么”，或是执行了下面的语句会怎么样，而不是解释下面怎么做，因为解释怎么做常常是与程序重复的，并对读者理解程序没有什么帮助。注释与上一段编码空一行，与下一段编码不空行，注释行与所注释程序段从同一列开始。8.4关键语句注释以单独一行注释来描述编码的作用和用法，一般在编码语句的上一行；如果注释和编码字数都不多时，可在编码同一行加注释，注释放在编码语句的尾部。九、其他9.1数据库相关命名原则使用delphi编程的程序员很难与数据库不发生联系。这里简要阐述一下相关数据库设计与编码的命名原则。9.1.1据库名命名数据库名前缀为db，后接项目名称，再加对库功能的描述。9.1.2数据库table名命名table名前缀为tb。对于由实体转化过来的table，命名加实体名的英文名称，英文名称首字母大写，其他字母小写；对于由不同实体相联系转化过来的table，命名为相联系的实体名的英文名称，中间加下划线；对于两个实体有两种多对多的联系，table命名为相联系第27页(共30页)Delphi程序员代码编写标准指南的实体名的英文名称和联系的英文名称，中间加下划线。9.1.3数据库字段名命名数据库字段名无前缀，命名为字段描述的英文名，对于比较长的名称，可以采用缩写形式。9.1.4数据库存储过程命名前缀为up_，后接对该存储过程用途的说明。例如：统计模块中进行具体统计用存储过程统一命名为up_StatProc?，?为后缀，用数字表示该统计的代码，如果该统计类型为1，则对应的存储过程命名为up_StatProc1。9.1.5数据库触发器命名前缀为trg_，后接对该存储过程用途的说明。例如：删除业务类型时的触发器命名为trg_DelOpType。9.1.6数据库临时Table名命名规则前缀为temptb，然后加上该Table的用途。9.2Delphi系统常量DateSeparator:='-'；ShortDateFormat:='yyyy-mm-dd'；LongDateFormat:='yyyy''年''mm''月''dd''日'；TimeSeparator:=':'；ShortTimeFormat:='HH:mm:ss'；LongTimeFormat:='HH:mm:ss'；这里日期与时间常量的格式都尽量用长格式，这样做可以防止编码中时间转换与运算中发生错误。但有特殊要求的需改变以上系统常量的表示格式。9.3基本提示信息程序运行时在与用户交互中常常要弹出提示窗，最基本的提示窗口的实现本着以下原则：1．实现方式：所有提示信息应在标题栏注明“提示信息”字样，弹出信息以Application.MessageBox实现。第28页(共30页)Delphi程序员代码编写标准指南2．分类：系统提供给用户的信息提示可分为三类、消息出现一个小写‘i’图标用以系统提供给用户的提示信息，有一“确认”按钮、问题出现一个问号（？）图标用以系统向操作员提出问题，允许其选择，有以下两种选择‘是，否’二选一‘是，否，取消‘三选一、错误出现一个红色╳图标当用户操作错误或系统出现错误时用以提示，有三种情况‘确认’按钮，选择后重新操作‘是，否’二选一‘是，否，取消‘三选一9.4基本编程要求9.4.1主要原则使用语言中的顺序、选择、重复等有限的基本控制结构表示程序逻辑；选用的控制结构中准许有一个入口和一个出口；复杂结构应该用基本控制结构进行组合嵌套来实现；程序设计过程应考虑最为广泛的可能性，要对设计对象有深入了解，应选择一种最为简洁，易修改、扩充的结构；少用或不用GOTO语句。9.4.2注意事项语句结构尽量不用否定的逻辑条件；尽量少用临时变量。输入输出对现有的环境改变有恢复原状的功能；应有完备的出错检查和出错恢复功能。确保所有变量在使用前都进行初始化；尽可能使用库函数；尽量用公共过程或子程序去代替重复的功能代码段；临时文件应在使用后删除。第29页(共30页)Delphi程序员代码编写标准指南9.4.3书写格式关于编码的书写格式在前面的章节中已介绍过，这里再重复一下：为增加可读性，依照程序的逻辑关系（循环语句、选择语句等），程序编码应采用锯齿状排版格式，缩进每级为2空格；对于一行写不下的情况，分为多行，并采用适当的缩进。自然的程序段之间用空行隔开；尽量不要一行多句；程序中必须加相应的注释。整理：姜作生2000年2月20日第30页(共30页)