软件开发代码规范c版.docVIP

..

..word..

文档编号

版本

密级

1.0

本部门开放

工作规X

共NUMPAGES14页

软件开发代码规X（C#版）

拟制:

日期：

2007-2-13

审核:

日期：

审核:

日期：

批准:

日期：

所有********

修订纪录

日期

修订版本

描述

作者

2007-2-13

1.00

初稿完成

2007-5-10

1.01

修正

2007-11-2

1.02

修正

目录

TOC\o1-3\h\z1、第一章命名规X4

1.1、第一节总则4

1.2、第二节变量命名规X4

1.2.1、CodeBehind内部命名规X4

1.2.2、控件命名规X5

1.3、第三节常量命名规X5

1.4、第四节命名空间、类、方法命名规X5

1.5、第五节接口命名规X6

1.6、第六节命名规X小结6

2、第二章代码注释规X6

2.1、第一节模块级注释规X（命名空间、类等）6

2.2、第二节方法级注释规X7

2.2.1、属性注释7

2.2.2、方法注释7

2.3、第三节代码间注释规X8

3、第三章编写规X8

3.1、第一节格式规X8

3.2、第二节编程规X9

3.2.1、程序结构要求9

3.2.2、可读性要求9

3.2.3、结构化要求10

3.2.4、正确性与容错性要求10

3.2.5、可重用性要求10

3.2.6、interface使用注意事项11

3.2.7、类使用注意事项11

3.2.8、流程控制语句注意事项12

3.2.8、其他应注意事项13

注：Pascal命名法则：即名称中所有单词的第一个字母大写其他字母使用小写形式。

Camel命名法则：即名称中第一个单词各个字母全部小写，其他部分遵循Pascal命名法则。

第一章命名规X

第一节总则

本命名规则除特殊提及外统一使用Camel命名法则。

如：controlMenu

命名时尽量不使用拼音，更不可使用拼音缩写（专有名词除外）。

如果使用品牌名称命名时其大小写尽量保持和品牌名称一致的样式。

如：LuX则命名时，不要写成LUX，或者Lux，而应该保持与原品牌名称风格一致使用LuX

使用专有名词或英文缩写命名时采用大写形式。

如：NIC

禁止使用仅区分大小写的方式命名。

如：Abc与abc仅用大写A来区分，这样写在类C系语言中不会出错，但是不利于系统的迁移

1.2、第二节变量命名规X

1.2.1、CodeBehind内部命名规X

1．公有字段/属性使用Pascal命名规则，私有变量/保护变量/局部变量使用Camel命名规则，遵循动宾结构。

例：

publicclassHello

{

privatestringuserName;

privateDateTimeloginTime;

privateboolisOnline;

publicstringUserName{

get{returnthis.userName;}

}

}

2．即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用意义描述性的名称。仅对于短循环索引使用单字母变量名，如i或j

3．在变量名中使用互补对，如Min/Max、Begin/End和Open/Close。

4．当一个方法内部变量繁多的时候，可以使用Camel命名法则，其中第一个单词可以使用变量类型的缩写来说明以示区别。

例：

stringstrName;

intintAge;

objectobjPerson;

1.2.2、控件命名规X

1．控件命名使用控件缩写加名称的方式

例：

控件

缩写

声明

Label

lbl

protectedLabellblName;

TextBox

txt

protectedTextBoxtxtContent;

CheckBox

chk

protectedCheckBoxchkRight;

Button

btn

protectedButtonbtnOK;

ListBox

lbx

protectedListBoxlstItem;

DropDownList

d