2014编程的语言规.docVIP

杭州故乡人科技网络有限公司 使 用 命 名 规 则 杭州 故乡人科技网络有限 研发 2008-7-7 1、概述 4 2、变量命名的总原则 4 2.1一般性规则 4 2.2对特定类型数据的命名 4 2.3关于短名称的使用 5 2.4其它应当避免的命名问题 5 3、Visual Stdio.Net(C#) 5 3.1大写样式 5 3.2区分大小写 7 3.3缩写 8 3.4措词 8 3.5避免类型名称混淆 9 3.6命名空间命名指南 11 3.7类命名指南 12 3.8接口命名指南 13 3.9特性命名指南 14 3.10枚举类型命名指南 14 3.11静态字段命名指南 15 3.12参数命名指南 15 3.13方法命名指南 15 3.14属性命名指南 16 3.15事件命名指南 17 4、 代码规则 18 4.1 Try-Catch 18 4.2 ErrorCode 19 4.3 If Then Else规则 19 5、数据库规范 19 5.1数据库涉及字符规则 19 5.3 数据库表命名规则 20 5.5 视图命名规则 20 5.6 存储过程命名规则 21 5.7 数据库设计文档规则 21 5.8 sql语句规则 21 6、控件命名规范 21 6.1 C#一般控件命名规范 21 7、C#注释规范 25 7.1 自建代码文件注释 26 7.2 模块（类）注释 26 7.3 类属性注释 27 7.4 方法注释 27 7.5 代码间注释 27 8、ASP规范说明 28 8.1 单页编写规范： 28 8.2全站文件构建规范 29 8.3对网页制作的要求 30 1、概述 Visual Studio.NET、Web站点，业务对象及数据库，同时项目人员包括设计人员、开发人员和测试人员等较多。为了保持应用程序、组件、文件的一致性，便于阅读和管理代码和结构，提高开发效率和产品的标准化，特制订一套开发规范和标准（包括命名规范和编码规范）。好的编码约定可使源代码严谨、可读性强且语意清楚，做到与其它语言约定相一致，并且提高直观性。希望设计、开发人员严格遵守此套开发规范和标准，并落实到自己的设计与代码程序中。 命名规范将包括：编程命名规范、业务对象命名规范、数据库命名规范、Web站点结构命名规范等。 编码规范将包括：C#编码规范、第三方模块使用规范等 本命名规范主要针对使用Visual Stdio.Net（C#语言）规范，即编程命名规范部分。请注意：在项目过程中，C#将作为首选语言。 2、变量命名的总原则 2.1???一般性规则 ?变量名称应当准确完整地描述了变量的含义 ?名称应当反映了业务上的问题而不是技术上或编程上的解决方法 ?名称的长度应当足够长 ?名称的最后一部分应当有限定符 ?应当用Count, Index或Nbr代替Num, No. 2.2??? ?循环计数变量的的名称应当有含义（如果循环语句的长度超过了两行或者存在着循环尽量避免使用I,j,k之类的变量，应该使用有意义的变量） ?临时变量的命名应当有意义 ?所有布尔型变量的命名能够直接从名称上看出为真的条件 ?枚举类型的变量名称应当包含了基础类型，能够方便的分辨变量的类型。例如：用olor变量表示?ColorRed, ColorGreen枚据类型的值。 ?命名的常量应当代表了抽象的实体而非他们所代表的值 ?从变量命名中应当可以看出变量的作用域是局部变量，模块变量或者全局变量 ?变量的名称中不同的单词首字母要大写，以方便阅读 2.3??? ??如果不是绝对必须，尽量避免使用短的名称 ??如果变量中单词的缩写只能缩短一两个字符则使用单词的完全拼写 ??所有单词的缩写规则应当一致 2.4??? ??名称具有误导性 ??两个不同的命名具有相似的含义 ??不同的命名拼写很相似，仅差一两个字符 ??在变量名称中不应当使用数字 ??完全和变量含义不相关的命名3、Visual Stdio.Net(C#) 3.1???大写样式 使用下面的三种大写标识符约定。 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor 大写 标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如： System.IO System.Web.UI 可能还必须大写标识符以维持与现有非托管符号方案的兼容性，在该方案中所有大写字母经常用于枚举和常数值。一般情况下，在使用它们的程