程序开发规范

 

 

 

   程序开发规范

    

目录

一、代码规范 .................................................................................................................... 3

1．注释 ...................................................................................................................... 3

1.1 类注释 ......................................................................................................... 3

1.2 方法说明 ..................................................................................................... 3

1.3 变量注释 ..................................................................................................... 3

1.4 程序段或语句注释...................................................................................... 3

2．缩进 ...................................................................................................................... 3

2.1 换行 ............................................................................................................. 3

2.2 空白 ............................................................................................................. 3

3．声明 ...................................................................................................................... 4

3.1 每行的声明数 ............................................................................................. 4

3.2 类和接口声明 ............................................................................................. 4

4．语句 ...................................................................................................................... 4

4.1 if、if-else、if else-if else语句 ..................................................................... 4

4.2 for/foreach、while语句 .............................................................................. 4

4.3 switch语句 ................................................................................................... 4

4.4 try-catch语句 ............................................................................................... 5

5．命名规范 .............................................................................................................. 5

5.1 类命名 ......................................................................................................... 5

5.2 方法命名 ..................................................................................................... 5

5.3 参数、变量命名 ......................................................................................... 5

5.4 文件命名 ..................................................................................................... 5

5.5 Web控件命名 .............................................................................................. 5

5.6 其他注意事项 ............................................................................................. 6

二、数据库命名规范......................................................................................................... 7

1、表命名 .................................................................................................................. 7

2、列命名 .................................................................................................................. 7

3、存储过程命名....................................................................................................... 7

4、视图命名 .............................................................................................................. 7

 

 

一、代码规范

1．注释

1.1 类注释

在每个类的开头加上注释，格式如下：

/// <summary>

/// ClassName:userManage

/// Version:1.0

/// DateTime:2009/8/28

/// Author:xxx

 /// Remark:逻辑业务层

/// </summary>

public class ClassName

{

}

 

1.2 方法说明

在类的方法声明前必须以以下格式编写注释：

/// <summary>

/// 对该方法的说明

/// </summary>

/// <param name="参数名称">参数说明</param>

/// <returns>对方法返回值的说明，该说明必须明确说明返回的值代表什么含义</returns>

 1.3 变量注释

重要变量必须有注释，格式要求如下：

（1）变量注释和变量在同一行，所有注释必须对齐。

（2）将注释与注释分隔符用一个空格分开。

1.4 程序段或语句注释

程序段或语句的注释在程序段或语句的上一行，每行注释的最大长度为100个字

符。

2．缩进

2.1 换行

当一个方法的声明或表达式超过一行时，根据以下原则进行处理：

（1）在逗号后换行。

（2）在操作符后换行。

2.2 空白

以制表符（Tab）为标准缩进符，不要用空格缩进。

 3．声明

3.1 每行的声明数

推荐每行只有一个声明，因为它可以方便注释。

int level; // indentation level

 

int size; // size of table

 

3.2 类和接口声明

当编写C#类和接口时，应遵循以下格式化规则：

（1）在方法名和圆括号“(”开始它的参数列表之间不要使用空格。

（2）在声明语句的下一行以大括号“{”标志开始。

（3）以“}”结束，通过它自身的缩进与相应的开始标志匹配。

4．语句

4.1 if、if-else、if else-if else语句

if (condition)

{

 

 DoSomething();

}

else

{

 

 DoSomethingOther();

}

 

4.2 for/foreach、while语句

for (int i = 0; i < 5; ++i)

{

.. }

while (condition)

{

}

注意：在一个循环中，即使只有一个语句通常也用括弧括起来。

4.3 switch语句

switch (condition)

{

case A:

. break;

case B:

 

 break;

default:

... break;

}

 

4.4 try-catch语句

try

{

...

 

} catch (Exception)

{}

或者

try

{

} catch (Exception e)

{

}

5．命名规范

5.1 类命名

（1）类命名必须是名词或名词短语。

（2）大写每个单词的第一个字母。

（3）不要用任何前缀。

如：ClassName。

5.2 方法命名

（1）用动词或动词短语命名方法。

（2）大写每个单词的第一个字母。

如：GetName()。

5.3 参数、变量命名

（1）除第一个单词外大写每个单词的第一个字母。

（2）计数变量当用在琐碎的计数循环式更适宜叫i, j, k, l, m, n。

如：name，strName。

5.4 文件命名

Web文件和类文件命名时，大写每个单词的第一个字母。

 如：FileName.aspx，ClassName.cs。

5.5 Web控件命名

（1）Web控件的命名规则：控件缩写名+控件作用的全称。

 （2）第一个单词外大写每个单词的第一个字母。

如：btnNext，txtPassword，txtRPassword，dgUserList。

以下是web控件对应的缩写：

AdRotator art

Button btn

Calendar cd

CheckBox chk

CheckBoxList chkl

CompareValidator cpv

CustomValidator ctv

DataGrid dg

 

GridView gv

DataList dl

DropDownList ddl

HyperLink hl

Image img

ImageButton ibtn

Label lbl

LinkButton lbtn

ListBox lst

Panel pl

PlaceHolder ph

RadioButton rb

RadioButtonList rbl

RangeValidator rv

RegularExpressionValidator rev

Repeater rp

RequiredFieldValidator rfv

Table tb

TableCell tc

TableRow tr

TextBox txt

ValidationSummary vs

XML XML

 5.6 其他注意事项

（1）命名时尽量不使用缩写，除非它是众所周知的

（2）名字可以由两个或三个单词组成，但通常不应多于三个。

  

二、数据库命名规范

 1、表命名

用一个或三个以下英文单词组成，单词首字母大写，如：DepartmentUsers。

 2、列命名

单词首字母大写，单词与单词之间加下划线，如：User_Name。单词id两个字母

都应大写，如：Department_ID。

3、存储过程命名

 “p_”+模块名+方法名，如：p_Driver_NewsAdd，p_User_NewsUpdate。

 4、视图命名

View_表名，如：View_News;