文档介绍:01编码规范
c#编码规
范
-2 -
1文件组
织
一 2一
1 C#源文
件
-2-
排
- 2- 2 缩
进
-2 -
1分
行
-2 - 3 注
释
-2 -
1块注
释
-2 - 3. 2单行注
释
-3 - 3. 3文档注
释
-3-4 声
明
-3 -
每行声明的数
量
- 3 - 4. 2 初始
化
-3 - 4. 3类和接口的声
明
-3 - 5 语
句
-4 -
1简单语 句
-4 - 5. 2返回语
句
一 4 一 5・ 3 If, if - else, if else - if else 语
句
.・ 一 4 一 4 for / foreach 语
句
一 5 一 5・ 5 while / do ❷C while 语
句
一 6 一 5・ 6 switch 语
句
一 6 一 5・ 7 try 0C catch 语
句
-6 一
性
-7 - 5. 9 枚
举
- 8- 6 空 白
一 8一
1空 行
-8 - 6. 2内部空
格
-8 - 7命名约 定
一8 一
1 命名规 范
一 9 一 7. 2 WebControl 命名规
范
一 9- 变
量
-10 - 7. 4 其
他
-10-8编程实 践
-11 -
1书写顺 序
-11- 性
-11 - 8. 3功能单
-12 - 8. 4使用枚 举
-12 - 8. 5捕获异 常
-13- 项
-13 -
C#编码规范
1文件组织
1 C#源文件
把每个类都放在单独的文件中,文件名字和类名一致()。类文件 不要太长,不要超过2000LOC必要时,分割代码,使结构更清晰。
为每个命名空间创建一个目录(如,对J- MyProject. TestSuite. TestTier使用 MyProject/TestSuite/TestTier作为路径,不要使用带”的命名空间)。这样更易尸 映射命名空间到目录。
2缩进
1分行
如果表达式不适合单行显示,应根据下面通常的原则分行:
? 在一个逗号后换行? 在一个操作符后换行? 在表达式
的高层次处换行
新行与前一行在同一层次,并与表达式的起始对
齐
方法分行的例子:
long MethodCall(exprl, expr2,
expr3, expr4, expr5);算术表达式分行的例子:好的:
var = a * b / (c❷C g + f) + 4 * z;坏的风格,要避免:
var = a * b / (c 0C g + f) + 4 * z;
第一个是好的,因为分行符合高层次规则。
3注释
1块注释
通常要避免块注释,而使用C#标准的〃/注释来描述。如果希望使用块注释,应该使 用下面的风格:/ * Line 1 * Line 2
- 2 -
* Line 3 */