C代码规范范本.docVIP

C#编码规范 目 录方针 该代码标准提供了相关软件开发项目中，使用C#进行编码时的规则，推荐代码标准，起到了一定的指示作用。 为了使该标准制定的方针浅显易懂，用了简单的代码来编写。而在实际的编程中，是需要项目小组所有成员同意该编写规则的。 对于实际项目，我们推荐将该标准以顾客为标准使用。 还有，我们还推荐读者参考配合.NET Framework SDK帮助的《面向对象开发设计指南》。 特别是在Extreme Programming项目中没有认识到的，可使用其它C#编程的项目中运用。 代码注释规范 文件功能，创建，修改信息注释 类功能注释 方法注释 较长的注释，*GY 需要复数行注释的情况下，在最初用短小的篇章写上想要注释什么。然后在添加上长的注释。另外,在感觉有必要写象如此长的注释之时, 请再三考虑一下,可否将程序设计再简化一下。请积极地应对。 目录文件构成 目录文件名 Public类会生成一个以该类命名的文件。 例：public class Customer里面有着Customer.cs。 包内的非公共类，最好放在包含该类经常被使用的公共类目录文件下。 对于特殊类，一个目录文件可以包含多个类。 目录文件的位置 决定了项目的根目录之后，在命名空间的“.”处输入导入目录的阶层位置。可是对应于solution/project的命名空间的阶层则用solution名/project名作为目录名来使用。 例：命名空间：CompanyName.OrganizationName.TechnologyName.CoreFeatureName.SubFeatureName Solution SolutionName 所对应的命名空间：TechnologyNameProject ProjectName 所对应的命名空间：CoreFeatureName 配置路径：C:\CompanyName\OrganizationName\SolutionName\ProjectName\SubFeatureName TestClass名 类ClassName的单元测试类是以ClassNameTest来命名的。Solution的每个测试都是以SolutionNameTests来命名的。 例：如果是Customer类的测试类的话就命名为CustomerTest.cs。 例：如果是CsSample的soultion的话，就把它命名为CsSampleTests.csproj。 理由：因为是这样命名是非常有一致性。可以成为使用测试代码的样例和演示版。 TestClass的位置 测试类的位置应配置在被测试类相同的阶层的目录下。 例：被测试类的位置：测试类的位置： 理由：如果不是物理位置较近的话,会被维护系统所遗漏。对于产品的代码分离这一点而言,用其他的工具（NAnt的build文件之类）也是可能调整的。 命名规则 NameSpace结构规范 NameSpace分类和命名原则 先根据解决方案（Solution）、业务系统（Application）、子系统（Sub）、模块(Module) 划分目录，然后在模块内部按照Web、Biz、integration层对NameSpace结构进行命名。 Web层NameSpace命名规范 Beyondbit.Solution.Application.Sub.Module.Web 业务层NameSpace命名规范 Beyondbit.Solution.Application.Sub.Module.Biz 数据访问层NameSpace命名规范 Beyondbit集成层NameSpace命名规范 该目录应用于解决方案（Solution）、业务系统（application）、子系统（sub），存放在一些与业务相关的通用处理程序，可以视为公共的模块，可包含Web、Biz、integration。 Util 该目录应用于解决方案（Solution）、业务系统（Application）、子系统（Sub），存放在一些与业务无关的通用处理程序。 文件名 Public类的命名一定要与文件名同名(包括大,小写的区别)。 类名 类名使用Pascal大小写形式。 异常类名 最后以Exception结尾。 接口名 与类名相同。此外，经常在最前面添加I。 interface IClassName 此外,在使用添加了某项功能的情况下,我们要加上可以表示这种功能的形容词,以-able结尾。 例: IEnumerable, ICloneable, IXmlSerializable, … 抽象类名 如果没有适合抽象类名的名字的时候,就联想以Abstract为开头的Subclass名作为抽象类的名字。 abstract class Abstract