文档介绍：软件编码规范(C#)
版本<>
修订历史记录
日期
版本
说明
作者
2006-9-5
初始创建
Maurice Zhong
目录
第一章概述 4
规范制定原则 4
术语定义 4
Pascal 大小写 4
Camel 大小写 4
文件命名组织 4
4
4
第二章代码外观 6
列宽 6
换行 6
缩进 6
空行 6
空格 6
括号- () 7
花括号- {} 7
第三章程序注释 9
注释概述 9
文档型注释 9
类c注释 10
单行注释 10
注释标签 10
第四章申明 14
每行声明数 14
初始化 14
位置 14
类和接口的声明 15
字段的声明 15
第五章命名规范 16
命名概述 16
大小写规则 16
缩写 17
命名空间 17
类 18
接口 18
属性(Attribute) 19
枚举(Enum) 19
参数 19
方法 20
属性(property) 20
事件 21
常量(const) 22
字段 23
静态字段 23
集合 24
措词 24
第六章语句 26
每行一个语句 26
复合语句 26
return 语句 26
if、 if-else、if else-if 语句 26
for、foreach 语句 27
while 语句 27
. do - while 语句 28
. switch - case 语句 28
. try - catch 语句 28
. using 块语句 29
. goto 语句 29
第七章 控件命名规则 30
命名方法 30
主要控件名简写对照表 30
第八章 其他 30
表达式 30
类型转换 30
附录一: 匈牙利命名法 31
第一章概述
规范制定原则
1 方便代码的交流和维护。
2 不影响编码的效率,不与大众****惯冲突。
3 使代码更美观、阅读更方便。
4 使代码的逻辑更清晰、更易于理解。
术语定义
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如:
BackColor
Camel 大小写
标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:
backColor
文件命名组织
1 文件名遵从Pascal命名法,无特殊情况,扩展名小写。
2 使用统一而又通用的文件扩展名: C#
1 在每个文件头必须包含以下注释说明
/*----------------------------------------------------------------
// Copyright (C) 2004 Cyberway
// 版权所有。
//
// 文件名:
// 文件功能描述:
//
//
// 创建标识:
//
// 修改标识:
// 修改描述:
//
// 修改标识:
// 修改描述:
//----------------------------------------------------------------*/
文件功能描述只需简述,具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如:
李轶20040408
一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。
第二章代码外观
列宽
代码列宽控制在110字符左右。
换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
1、在逗号后换行。
2、在操作符前换行。
3、规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
缩进
缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。
Visual 设置:工具->选项->文本编辑器->C#->制表符->插入空