1 / 25
文档名称:

软件代码编写规范.docx

格式:docx   大小:34KB   页数:25页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

软件代码编写规范.docx

上传人:百里登峰 2020/10/18 文件大小:34 KB

下载得到文件列表

软件代码编写规范.docx

文档介绍

文档介绍:。对这些命名指南广泛的使用和理解将消除许多最常见的用户问题。Framework类型的命名指南。对于每个类型,还应该注意关于大写样式、区分大小写和措词的一些通用规则。 Pascal大小写、Camel大小写和全部大写样式。使用下面的三种大写标识符约定。Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal大小写。例如:BackColorCamel大小写标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:backColor大写标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如:,在该方案中所有大写字母经常用于枚举和常数值。一般情况下,在使用它们的程序集之外这些字符应当是不可见的。下表汇总了大写规则,并提供了不同类型的标识符的示例。标识符大小写示例类PascalAppDomain枚举类型PascalErrorLevel枚举值PascalFatalError事件PascalValueChange异常类PascalWebException注意 总是以Exception后缀结尾。只读的静态字段PascalRedValue接口PascalIDisposable注意 总是以I前缀开始。 Camel redValue注意 很少使用。属性优于使用受保护的实例字段。公共实例字段 Pascal RedValue注意 很少使用。属性优于使用公共实例字段。,请遵循有关区分大小写的使用的下列规则:? 不要使用要求区分大小写的名称。对于区分大小写和不区分大小写的语言,组件都必须完全可以使用。不区分大小写的语言无法区分同一上下文中仅大小写不同的两个名称。 因此,在创建的组件或类中必须避免这种情况。? 不要创建仅是名称大小写有区别的两个命名空间。 例如,不区分大小写的语言无法区分以下两个命名空间声明。?;;? 不要创建具有仅是大小写有区别的参数名称的函数。下面的示例是不正确的。voidMyFunction(stringa,stringA)? 不要创建具有仅是大小写有区别的类型名称的命名空间。在下面的示例中, Pointp和POINTp是不适当的类型名称,原因是它们仅在大小写方面有区别。?? 不要创建具有仅是大小写有区别的属性名称的类型。在下面的示例中, intColor和intCOLO揭不适当的属性名称,原因是它们仅在大小写方面有区别。?intColor{get,set}intCOLOR{get,set}? 不要创建具有仅是大小写有区别的方法名称的类型。 在下面的示例中,calculate和Calculate是不适当的方法名称,原因是它们仅在大小写方面有区别。voidcalculate()voidCalculate(),请遵循有关区缩写的使用的下列规则:? 不要将缩写或缩略形式用作标识符名称的组成部分。例如,使用 GetWindow,而不要使用GetWin。? 不要使用计算机领域中未被普遍接受的缩写。? 在适当的时候,使用众所周知的缩写替换冗长的词组名称。 例如,用UI作为UserInterface 的缩写,用OLAP作为On-lineAnalyticalProcessing 的缩写。? 在使用缩写时,对于超过两个字符长度的缩写, 请使用Pascal大小写或Camel大小写。例如,使用HtmlButton或htmlButton。但是,应当大写仅有两个字符的缩写,如,,。? 不要在标识符或参数名称中使用缩写。 如果必须使用缩写,对于由多于两个字符所组成的缩写请使用 Camel大小写,虽然这和单词的标准缩写相冲突。。例如,不要将以下任何名称用作类名称: System>Collections、Forms或UI。Framework命名空间的列表,请参见类库。另外,避免使用和以下关键字冲突