接上篇——C#编码规范(1)

 

()代码格式书写规范

1.代码书写格式

1)所有的缩进TAB键为4个空格,每个单词的首字符大写,其余小写。

2)在代码中垂直对齐左括号和右括号。例:

if(x==0)

{

Response.Write("用户名必须输入!");

}

不允许以下情况:

if(x==0){

Response.Write("用户名必须输入!");}

或者  if(x==0){Response.Write("用户名必须输入!");}

3)在大多数运算符之前和之后使用空格,这样做时不会改变代码的的意图却可以使代码容易阅读。

例:int j = i + k;而不应写为:int j=i+k;

4)缩写SQL语句时,对于关键字使用全部大写,对于数据库元素(如表,列和视图)使用大小写混合)。

5)将每个主要的SQL子句放在不同的行上,这样更容易阅读和编辑语句。

2注释的写法

1)在你劳神的地方请加上详细的注释说明,除了最简单的存取成员变量的Set/Get属性之外,其余大部分的方法写上注释是良好的习惯,尽量使你的程序让别人很容易看懂。

2多的注释会使程序很难看,但一些复杂的算法和数据结构处还是要加上注释的,这样别人就容易看懂,否则时间长了,你自己都未必能看明白了。

3)如果是对某一段程序(算法/结构)的注释,在程序头直接用//再空一格进行说明,一行不要超过80个字符。

4)为了防止在阅读代码时不得不左右流动源代码编辑器,每行代码或注释在不得超过一显示屏。

5)使用连续的多个//表示注释行(不要超过80字符)。

6)文件头部应有注释,简单描述文件的内容

7)对于程序中的比较关键的算法和方法,必须加注释。

3cs文件的书写

1)各个部分应使用注释行和空行分割,并在必要的地方写上注释。

2)函数之间用注释各空行分割。中间的内容缩进一个TAB

.其他

1.变量

(1)floatbool禁止用"=="判断.bool应该用逻辑运算关系符,float应该用差值区间来判断"相等";

(2)类型转换一律用显示类型转换

(3)类型的长度一律用sizeof()获得;

(4)当声明一个变量时,务必要自已初始化一下变量;

2.方法

(1)功能单一,方法名要名符其实.

(2)要易懂,实现时不要过分追求技巧,优化放到后面去做.

(3)长度一般禁止超过25.

(4)要检查输入值是否合法,实现(成员)方法时务必要求输入参数是在要求范围之内,尤其你定义的(成员)方法给别人调用时,要判断其合法性.

(5)调用方法时要严格按照接口规范调用,调用后要判断执行情况,并做适当的错误处理(尔后会给出错误和异常处理规范)

(6)尽量避免整块复制代码段,如果出现这样的情况要分析原因,如果这段代码完成独立的功能,应考虑封装为一个方法.

(7)if/while等语句中和条件表达式的运算结果必须为显示的Bool

(8)禁止使用goto语句

:

标识符 大小写方式 示例   

标识符大小写规则

标识符

大小写

示例

Pascal

AppDomain

枚举类型

Pascal

ErrorLevel

枚举值

Pascal

FataError

事件

Pascal

ValueChanged

异常类

Pascal

WebException

只读的静态字段

Pascal

ReadValue

接口

Pascal

IDisposable

方法

Pascal

ToString

命名空间

Pascal

System.Drawing

属性

Pascal

BackColor

参数

Camel

typeName