房产中介管理系统(编程规约).docVIP

房产中介管理系统 编程规约V1.0 宁波驰拓信息科技有限公司 说明与注释 类说明 类的说明主要用于对该类的描述以及记录修改履历，每个类的头部都必须加上类说明，具体格式如下： //------------------------------------------------- //类名：XXXXXXXXX //------------------------------------------------- //说 明：XXXXXXXXX //创建者：XXX //时 间：2010-07-07 //------------------------------------------------- //修改者： //时 间： //修改内容： //------------------------------------------------- 方法说明 方法说明用于描述方法的作用，参数及返回值的说明，采用.NET默认的说明方式,在方法头部加上三个斜杠，开发环境会根据所编写的方法自动形成注释的格式，其格式如下： /// summary /// 此处填方法说明 /// /summary /// param name=参数名根据方法自动产生此处填参数说明/param /// returns返回值说明/returns 注释 注释主要分为单行注释与多行注释两种，单行注释用两斜杠表示：“//”,多行注释用：“/*……..*/”，代码说明注释推荐使用两斜杠，对声明的变量的注释放在变量后面，与声明为同一行，对代码的注释要另起一行，并放在代码的前一行，示例如下： MSGCompanyNews objMSGCompanyNews; // 公司信息类 BLLCompanyNews objBLLCompanyNews; // 公司类业务逻辑层 int intRet; //返回值 //初始化对象 objBLLCompanyNews = new BLLCompanyNews(); objMSGCompanyNews = new MSGCompanyNews(); //获取控件的值到公司信息类 objMSGCompanyNews.CompanyName = this.txtCompanyName.Text; objMSGCompanyNews.Tel = this.txtTel.Text; objMSGCompanyNews.Email = this.txtEmail.Text; 空行与缩进 为了提高代码的可读性方便其他程序员的理解，除了添加说明与注释外在代码与代码之间还需要适当添加空行与缩进，一般变量的声明与代码之间要添加空行，一个功能代码段结束与新的功能代码开始的行之间要添加一个空行。具体示例请看上面代码 类的命名 房产中介管理系统为三层式框架，每一层里边类有固定的标识，用来区分，以下给出具体规则： 表示层：首字母大写，取名简短要有意义，单词太长可以用缩写示例：CompanyNews 逻辑层：类开头加上“BLL”均为大写，后面跟有意义的单词，如：BLLCompanyNews 数据层：类开头加上“DAL”均为大写，后面跟有意义的单词，如：DALCompanyNews 模型层：类开头加上“MSG”均为大写，后面跟有意义的单词，如：MSGCompanyNews 变量命名 类型 缩写 示例 string str strName int int intAge long lng lngValue bool bln blnRet decimal dec decMoney DateTime dte dteStartDay Double dbe dbeValue Image img imgView List lst lstData 数据对象类型 obj objConnection 自定义类 obj objDALCompanyNews 控件命名 控件名 缩写 示例 TextBox txt txtName Label lbl lblName ListBox lbx lbxCompany Button btn btnSave CheckBox chk chkRegion CheckedListBox clx clxTest ComboBox cbx cbxClass