程序设计规范文档-read.doc

商汇系统 - 程序设计规范文档 简述： 所有名字统一通过对英文的缩写或者组合来表达。(注：UCP是Unified Communication Platform的缩写)，数据库操作使用存储过程，客户端代码请使用JQuery或者.NET AJAX框架来实现，文本均需写进资源文件里边，module的样式尽量使用dotnetnuk的default.css中已经定义的，如须使用自己的样式文件，请在本module的根目录下建立module.css文件，并将样式定义放入其中，样式定义命名规则如附录四：CSS类及id中的命名规则 目录结构要求按照dotnetnuke Module的目录结构要求规范化，如：资源文件放到本Module的子目录App_LocalResources下，资源文件名为对应ascx名称+”.”+zh-cn.resx，逻辑代码应该规范在逻辑层文件中（CBO，Controller，Centralized Custom Business Object Hydration），数据库访问层以Provider的设计模式实现，表现层要求实现样式和内容分离，提示性字符串要求写到资源文件中。 Module间需要做到独立性强，Module间的联系尽量通过配置的方式来实现。 名字空间（Namespace）规则，名字空间的命名规则遵循DNN对module的命名规则，采用公司名称（或者项目名称）+“.” +Modules + “.” + 模块名 + “.” + 功能名 例如个人资料Module的名字空间（Namespace）的命名规则如下： UCP.Modules.Profile.EditProfile UCP.Modules.Profile.ViewProfile UCP.Modules.Profile.Settings 其它module请参考该命名规则 程序集命名规则 为避免代码冲突, 现将本系统程序集名称规范如下。例如个人资料Module的程序集名称为：UCP.Modules.Profile.dll. 类，变量、方法、以及属性 类，量、方法和属性的名称的第一个字母须大写，并且名称应该能表达出它们的用途（或者说是意义）。如： 变量“员工名称”，其在程序中的变量名称须为：EmployeeName，变量“字节数”，其在程序中的名称须为：NumberOfBytes等等。 方法“添加数据”的名称须为：AddData（），动词（Add）+动词对象名称（Data） 数据库表名以及存储过程命名规范 数据库对象包括表、视图（查询）、存储过程（参数查询）、函数、约束。对象名字由项目名前缀，对象类型名和实际名字组成，长度不超过30。前缀和对象类型名：使用小写字母。 本项目数据库对象表名由 “模块名” + “_”+ 本表的业务名，如表的业务名称与模块名称一致，用模块名即可，如个人资料表名称为“Profile”，存储过程的命名由动词+动词对象名称，如：AddProfile， DeleteProfile，GetProfile， UpdateProfile CSS类及id的规范化命名 根据在文档中的使用目的来对类以及id进行结构化命名，详细情况 未尽事宜请参考如下附录和/articleimg/magazine/noahweb/4/和dotnetnuke的相关命名规则。 附录： 附录一：.NET中的命名规则 附录二：网站文件命名规则 附录三：数据库中的命名规则 附录四：CSS类及id中的命名规则 附录一：.NET中的命名规则 名称空间的命名　 　　 命名名称空间的一般规则如下： 　　 CompanyName.TechnologyName　　这样，我们看到的名称空间应该是这样的：　　　 　Microsoft.Office　　 PowerSoft.PowerBuilder 　 　　 　　 　　 　　 　　 　　 　　 　　 　　 　 　　注意：这只是一个原则。第三方公司可以选择其它的名字。　　避免用公司名称或其它著名品牌的名称作为名称空间的前缀，这样会造成两个公布的名称空间有同一个名称的可能性。　　例如： 将微软提供的Office自动类命名为Microsoft.Office 　　使用Pascal大写方式，用逗号分隔逻辑成分。　　例如：Microsoft.Office.PowerPoint 　　如果你的品牌使用的是非传统大写方式，那么一定要遵循你的品牌所确定使用的大写方式，即使这种方式背离了通常的名称空间大写规则。　　例如：NeXT.WebObjects　　　　　ee.cummings 类和类成分的命名 　　类的命名原则是用名词或名词短语命名类，使用Pascal大写。减少类名中缩写的使用量。不要使用任何类前缀（比如C），不要使用带下划线的字符。　　例如：