源程序书写规范

源程序书写规范

ID:37671671

大小:143.98 KB

页数:10页

时间:2019-05-28

源程序书写规范_第1页
源程序书写规范_第2页
源程序书写规范_第3页
源程序书写规范_第4页
源程序书写规范_第5页
资源描述:

《源程序书写规范》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库

1、源程序书写规范命名对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现(它们会发生改变)的名称,可以保留简化复杂性的抽象层。例如,可以使用GetNextStudent(),而不是GetNextArrayElement()。命名原则是:选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义,并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读;因此,提供人们可以理解的名称是有意义

2、的。不过,请确保选择的名称符合适用语言的规则和标准。以下几点是推荐的命名方法。Namespace名1.使用Pascalcase命名。2.使用公司名.产品名这样的格式。当商标(产品名)的命名风格和Pascalcase不相符的时候,以商标(产品名)为准。3.Namespace中类的依赖关系应该体现在命名上,比如System.Web.UI.Design中的类以来于System.Web.UI。4.在语意合适的情况下使用复数,比如System.Collections。例外是缩写和商标的情况。5.Namespace的名字不

3、一定和Assembly一一对应。类名1.文件名要和类名匹配。例如,对于类HelloWorld,相应的文件名应为helloworld.cs(或,helloworld.vb)2.3.枚举名称不要加Enum前缀或者后缀。枚举名用单数形式,不要用复数形式。枚举的成员使用Pascal命名。仅仅在这个Enum类型是bitfields地时候使用复数形式,并且总是给bitfieldEnum类型添加FlagsAttribute。4.接口名加I前缀,接口的成员使用Pascal命名。5.事件,委派如果delegate用来定义事件,加

4、EventHandler后缀。如果delegate用来定义callback方法,加Callback后缀(实际的callback方法不要加Callback后缀)。用动词命名事件,不要加Event后缀或者前缀。不要在事件声明中使用前缀和后缀,比如,用Close而不是OnClose。用ing和ed后缀来表示先后概念,不要用before,after,begin,end模式。一般的,你应该同时提供一个名字为OnXxx的protectedmethod供派生类来改写6.使用特定的设计模式(包括但不限于GoF的23种模式)时使

5、用适当类名称表明类在该模式中的功能职责。7.类名中不使用C前缀。比如CWindow。8.使用后缀的形式指明在设计上具备某种作用的类,如:Exception类类名加Exception后缀:WordWordException组件类:WordWordBean组件中的值类型:WordWordBeanInfo适配器:WordWordAdapterAttribute类类名加Attribute后缀:WordWordAttribute。在MiniDAC中,常使用的类名后缀:-Dac,-Info,-Utility。另外,后缀Cl

6、ass有助于避免和已有的命名冲突:WordWordClass9.对于特定用途的专业应用的类库可使用统一的前缀,前缀可以是用途名也可以是公司名,格式为WrdWordWord,如用于图形平台的所有类以Cad开头,如CadLine,CadCircle等。10.测试类的命名使用Test前缀。例程(方法、函数)1.避免容易被主观解释的难懂的名称,如对于例程的AnalyzeThis(),或者对于变量的xxK8。这样的名称会导致多义性,而不仅仅是抽象。2.在面向对象的语言中,在类属性的名称中包含类名是多余的,如Book.Bo

7、okTitle。而是应该使用Book.Title。3.使用动词-名词的方法来命名对给定对象执行特定操作的例程,如CalculateInvoiceTotal()。4.在允许函数重载的语言中,所有重载都应该执行相似的函数。对于那些不允许函数重载的语言,建立使相似函数发生关系的命名标准。5.在一个类中,各个方法需用一空行,也只能是一行分开。6.书写表达式时,在每个运算符和括号的前后都空一格。7.方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。8.考虑使用和proper

8、tytype名字相同的名字作为propertyname。9.特殊情况下的组合名字,尤其是代码生成时可以使用组合名字:名字_名字_名字,如StatusStrip_DoubleClicked10.WordWordWord的缩写词在命名时使用Wwww的形式,如OkButton,SqlConnection,不使用OKButton,SQLConnection。缩略词只有两个字母也遵守(和MS的规

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。