C# 编码常识

C# 编码常识

C#编码规则

Pascal和Camel命名约定

编程的命名方式主要有Pascal和Camel两种

A:à Pascal：每个单词的首字母大写，例如ProductType。

B:à Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType。

C:à 系统采用“动宾结构”，即所有的方法、委托等都用“动词”＋“名词”结构，如：AddUser、EditUser、DelUser、GetUser。

D:à 在“显示层”中实例化“BLL”业务层的类，类命名方式为：“C”＋“类名称”如：CUser。

E:à在Fdays.BLL业务层中的类，命名方式为：“B”＋“表名”，如：BUser。

F:à在Fdays.Model实体层中的实体，命名方式为：“MO_”＋“表名”，如：MO_user。

G:à在Fdays.IDAL数据层中的接口，命名方式为：“I”＋“表名”，如：IUser。

H:à在Fdays.SqlServerDAL数据层中的类，命名方式为：“D”＋“表名”，如：DUser。

I:à 所有的方法和属性写上注释。注释至少包括三部分：一）功能说明；二）Author：三）Create Date:　若修改函数则须添加：四）Editor:及五）Edit Date:

格式如下所示：

   /// <summary>

        /// 功能：根据用户ID获取用户及公司信息

        /// Author：Dragon

        /// Create Date：2008-8-9

        /// Editor: Dragon

        /// Edit Date: 2008-9-20

        /// </summary>

        /// <param name="P_userId"></param>

  /// <returns></returns>

代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。

1、  类（class）：Pascal规则

2、  枚举类型（enum）：Pascal规则

3、  委托类型（delegate）：Pascal规则

4、  常量（const）: 全部大写字母

5、  接口（interface）: 注：总是以 I 前缀开始，后接Pascal命名

6、  方法（function）：Pascal规则

7、  命名空间（namespace）：Fdays + “.” + Pascal规则

8、  参数：Camel规则

9、  数据成员：以“_”开头 + Camel规则

10、     属性：Pascal规则

常用参数命名规则

1、变量命名：首写字母大写，如：UserName

2、函数传参命名：首写字母大写，如：AddUser(string UserName”)

3、DataSet变量命名为：Ds

4、DataTable变量命名为：Dt

5、DataReader变量命名为： Dr

6、DataView变量命名为：Dv

7、SQL语句命名为：Sql

8、SQL补丁语句命名为：Sqlplus

9、SqlParameter[]命名为：Params

10、     Bool变量命名为：Bl

数值转换规则

1、转为整数：Int32.Parse

2、转为Double: double.Parse

3、以此类推

控件命名规则

1、控件命名 = Web控件缩写前缀 + 变量名

A：标准控件

l  AdRotator = adrtUser

l  Button = btnAddUser

l  Calendar = calUser

l  CheckBox = chkUser

l  CheckBoxList = chklUser

l  CompareValidator = valcUser

l  CustomValidator = valxUser

l  DropDownList = ddlUser

l  HyperLink = lnkUser

l  Image = imgUser

l  ImageButton = ibtnUser

l  Label = lblUser

l  LinkButton = lbtnUser

l  ListBox = lstUser

l  Panel = pnlUser

l  PlaceHolder = plhUser

l  RadioButton = radUser

l  RadioButtonList = radlUser

l  Repeater = rptUser

l  Table = tblUser

l  TableCell = tblcUser

l  TableRow = tblrUser

l  TextBox = txtUser

l  XML = xmlc

l

B：数据控件

l  GridView = gvUser

l  DataGrid = dgUser

l  DataList = dlUser

l  DetailView = dvUser

l  Repeater = rptUser

l  AspNetPage = apgUser

l  ListView = lvUser

l  FormView = fvUser

C：验证控件

l  RequireFieldValidator = rfvUserName

l  RangeValidator = rvUserName

l  RegularExpressionValidator = revUserName

l  CompareValidator = cvUserNaem

l  CustomValidator = cuvUserName

D：AJAX Extension控件

l  UpdatePanel = uppAddUser

l  UpdateProgress = upprogAddUser

E：编辑器控件

l  CuteEditor = ceContent

l  FckEditor = fckContent

文件名命名规则

1、  所用Pascal规则，即每个单词的字母都大写

2、  采用“动宾格式”，即“动词”＋“名词”，如：AddUser.aspx

3、  文件命名尽量采用英文，每个文件名称不要超过25个字母

系统设计架构

本系统采用三层架构开发，实现表示层、业务层及数据层三层分离，基于简单工厂和面向接口的开发思想，利用反射原理，实现动态调用数据库，有利于今后数据库的更改及系统的扩展与维护。