BS系统通用开发规范.pdf

B/S 系统通用开发规范 版本1.0.01 修改人 修改时间 版次 说明 吴重强 2012-12-13 V0.1.00 初稿 吴重强 2012-12-17 V1.0.01 复核，发布。 1 命名规范种类 1.1 Pascal Casing 帕斯卡规范：将标识符的首字母和后面连接的每个单词的首字母都大写。 例如： BackColor 1.2 Camel Casing 骆驼规范：标识符的首字母小写，而每个后面连接的单词的首字母都大写。 例如：backColor 1.3 Upper Casing 大写规范：所有字母全部大写。 例如：URL 1.4 Lower Casing 小写规范：所有字母全部小写。 例如：name 2 命名规范 2.1 命名规范通用与原则  具有公共特性的对象名称，一般使用Pascal 方式名称，如文件名、命名空间、类名、属 性名、方法名等； 具有内部特性的对象一般使用Camel 方式 命名，如方法的参数名，方法内的变量名。  具有明显动作意向的对象，如函数、方法一般使用动词+名词或名词短语来命名，如果 类的所描述的内容意义单一，也可以单独使用动词作来命名，如Get、Save 等。 其它对象一般使用名词或名词短语来命名。  禁止单独使用系统关键字、系统命名空间名、系统类名来命名一个对象。如回避有难度， 则应使用组合的方式取代。如用MySystem、SystemName 来取代直接使用System 。  当需要使名称缩写名称时，一定要选用众所周知的或在行业中已经约定俗成的缩写，如 URL、IO、ERP、BPM 等。不要使用自创的或意义不明的缩写。缩写的字母全部大写。  除用于for 、while 等循环中的变量外，禁止使用单个字母 （如i，n，x ）来命名对象。  类、结构体、枚举等直属于命名空间下的对象，不能和已有命名空间重名。  除特别要求外，所有系统关键字全部小写。  命名用词要简单、直观、易于理解。不要使用过于复杂和生僻的单词。在能够描述对象 属性或功能的情况下，尽可能使用简单的词语，建议不超过半角30 个字符。  命名风格要一致。全局一致、上下文后一致，尽量不要出现特例。 2.2 文件对象命名规范 对象 命名规范 说明 文件名 Pascal 编码类文件使用 Pascal 命名或遵循其开发工具的默认 规范。 说明性的文档可使用有意义的中文短语命名。 文件扩展名 Lower 2.3 C#对象命名规范 对象 命名规范 说明 命名空间 Pascal 类名 Pascal 属性 Pascal 字段 Camel 特指类级别中的变量。 常量 Pascal 方法 Pascal 方法的参数 Camel 变量 Camel 特指方法级别中的变量。 枚举 Pascal 枚举值 Pascal 事件 Pascal 接口 Pascal 前缀：I （一位大写字母） 结构体 Pascal 关键字 Lower 配置文件中的节点 Pascal 配置文件中的属性 Pascal 单词缩写 Upper 2.4 网页对象命名规范 对象 命名规范 说明 HTML 标签 L