代码编写管理规定.doc

代码编写管理规定

XXX公司代码编写管理规定XXXXX公司编号编制审核批准发布日期

修改记录序号文件更改内容修改日期修改人版本1AV1.0（A-新增，M-修改，D-删除）

目录1.目的42.范围43.职责44.术语45.程序46.相关文件317.相关记录31

11..目的为确保XXX公司软件开发项目代码编写过程得到有效管控，以确保代码的安全性、可读性、适用性，特制定本规定。

22..范围适用于软件开发项目的代码编写活动。

33..职责产品事业部：负责代码的编写、评审。

增值业务部：负责代码的编写、评审。

44..术语编码：编码是信息从一种形式或格式转换为另一种形式的过程。

55..程序5.1.asp.net编码规范5.1.1页面设计部分5.1.1.1Img控件所有展示类图片都要具有能简要描述图片内容的文字说明。

5.1.1.2Input控件maxlength：所有INPUT控件都需要制定maxlength属性，默认值为数据库中对应的字段的长度。

readonly：所有不可更改的信息都要使用readonly属性。

5.1.1.3控件的命名将默认名称中的序号用有意义的名称代替，如：存储按钮默认为Button1改为Button_Save

5.1.2客户端程序部分5.1.2.1提示每次操作都应该返回提示。

5.1.2.2错误提示信息的处理所有错误提示信息全部使用中文，标点使用中文半角符号，格式如下：

quot;错误：quot;+提示信息+quot;！quot;5.1.2.3成功提示信息的处理所有成功提示信息全部使用中文，标点使用中文半角符号，格式如下：

quot;成功：quot;+提示信息+quot;！quot;5.1.2.4提交前数据的验证1)是否为数字2)长度判断3)为空判断5.1.2.5删除数据前的提示所有涉及删除的操作，在用户选定以后都要再进行一次确认操作。

5.1.3服务器端程序部分5.1.3.1对象的关闭所有数据库和文件对象都要在使用后尽可能早的close，同时赋nothing。

5.1.3.2可移植配置管理将可能在部署或升级时可能发生变化的信息进行动态设置处理。例如：数据适配器中连接串动态配置。

5.1.4模糊查询在文本框中输入！表示匹配单个字符、%表示匹配多个字符。

5.1.5必输内容标示用*标示必输内容。

5.2.C#编程规范5.2.1命名规范命名总体原则：

将默认名称中的序号用有意义的名称代替，如：存储按钮默认为Button1改为Button_Save。

其他命名原则是：

1）使名称足够长以便有一定的意义，并且足够短以避免冗长；2）使用容易让人理解的名称，避免容易被主观解释的难懂的名称；3）尽量减少使用缩写；4）鉴于大多数名称都是通过连接若干单词构造的，请使用大小写混合的格式以简化它们的阅读。

5.2.1.1类以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如：

ClassIndicator当类是一个特性（Attribute）时，以Attribute结尾，当类是一个异常（Exception）时，以Exception结尾：

ClassColorSetException

ClassCauseExceptionAttribute当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如：

ClassScreenClassClassSystemClass当类只用于作为其他类的基类，根据情况，以Base结尾：

MustInheritClassIndicatorBase如果定义的类是一个窗体，那么名字的后面必须加后缀Form，如果是Web窗体，必须加后缀Page：

ClassPrintForm:InheritsForm”*Windows窗体ClassStartPage:InheritsPage”*Web窗体其他原则：

1)使用Pascal大写。

2)减少类名中缩写的使用量。

3)不要使用任何类前缀（比如C）。

4)不要使用带下划线的字符。

publicclassFileStream{}publicclassButton{}

publicclassString{}5.2.1.2枚举和结构同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如：

EnumColorButtons”以复数结尾，表明这是一个枚举StructureCustomerInfoRecord”以Reco