编程的语言规范.doc

杭州故乡人科技网络有限公司使用命名规则杭州故乡人科技网络有限研发2023-7-71、概述42、变量命名的总原则42.1一般性规则42.2对特定类型数据的命名42.3关于短名称的使用52.4其它应当避免的命名问题53、VisualStdio.Net(C#)53.1大写样式53.2区分大小写73.3缩写83.4措词83.5避免类型名称混淆93.6命名空间命名指南113.7类命名指南123.8接口命名指南133.9特性命名指南143.10枚举类型命名指南143.11静态字段命名指南153.12参数命名指南153.13方法命名指南153.14属性命名指南163.15事件命名指南174、代码规则184.1Try-Catch184.2ErrorCode194.3IfThenElse规则195、数据库规范195.1数据库涉及字符规则195.3数据库表命名规则205.5视图命名规则205.6存储过程命名规则215.7数据库设计文档规则215.8sql语句规则216、控件命名规范216.1C#一般控件命名规范217、C#注释规范257.1自建代码文献注释267.2模块（类）注释267.3类属性注释277.4方法注释277.5代码间注释278、ASP规范说明288.1单页编写规范：288.2全站文献构建规范298.3对网页制作的规定301、概述系统项目的建设过程中，涉及到VisualStudio.NET、Web站点，业务对象及数据库，同时项目人员涉及设计人员、开发人员和测试人员等较多。为了保持应用程序、组件、文献的一致性，便于阅读和管理代码和结构，提高开发效率和产品的标准化，特制订一套开发规范和标准（涉及命名规范和编码规范）。好的编码约定可使源代码严谨、可读性强且语意清楚，做到与其它语言约定相一致，并且提高直观性。希望设计、开发人员严格遵守此套开发规范和标准，并贯彻到自己的设计与代码程序中。命名规范将涉及：编程命名规范、业务对象命名规范、数据库命名规范、Web站点结构命名规范等。编码规范将涉及：C#编码规范、第三方模块使用规范等本命名规范重要针对使用VisualStdio.Net（C#语言）规范，即编程命名规范部分。请注意：在项目过程中，C#将作为首选语言。2、变量命名的总原则变量命名的总原则是一个通用性的原则，本规范后续章节中的命名规则都应当符合这些总原则。2.1一般性规则变量名称应当准确完整地描述了变量的含义名称应当反映了业务上的问题而不是技术上或编程上的解决方法名称的长度应当足够长名称的最后一部分应当有限定符应当用Count,Index或Nbr代替Num,No.2.2对特定类型数据的命名循环计数变量的的名称应当有含义（假如循环语句的长度超过了两行或者存在着嵌套循环,尽量避免使用I,j,k之类的变量，应当使用故意义的变量）临时变量的命名应当故意义所有布尔型变量的命名可以直接从名称上看出为真的条件枚举类型的变量名称应当包含了基础类型，可以方便的分辨变量的类型。例如：用Color变量表达ColorRed,ColorGreen枚据类型的值。命名的常量应当代表了抽象的实体而非他们所代表的值从变量命名中应当可以看出变量的作用域是局部变量，模块变量或者全局变量变量的名称中不同的单词首字母要大写，以方便阅读2.3关于短名称的使用假如不是绝对必须，尽量避免使用短的名称假如变量中单词的缩写只能缩短一两个字符则使用单词的完全拼写所有单词的缩写规则应当一致2.4其它应当避免的命名问题名称具有误导性两个不同的命名具有相似的含义不同的命名拼写很相似，仅差一两个字符在变量名称中不应当使用数字完全和变量含义不相关的命名3、VisualStdio.Net(C#)3.1大写样式使用下面的三种大写标记符约定。Pascal大小写将标记符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标记符使用Pascal大小写。例如：BackColorCamel大小写标记符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor大写标记符中的所有字母都大写。仅对于由两个或者更少字母组成的标记符使用该约定。例如：System.IOSystem.Web.UI也许还必须大写标记符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。一般情况下，在使用它们的程序集之外这些字符应当是不可见的。下表汇总了大写规则，并提供了不同类型的标记符的示例。标记符大小写示例类PascalAppDomain枚举类型PascalErrorLevel枚举值PascalFatalError事件PascalValueChange异常类PascalWebException注意总是以Exception后缀结尾。只读的静态字段Pas