.net下分层架构系统的开发技术规范(1)

DotNet项目组编码规范

Bill_Fang

2004-3-15

 

要开发出专业化的软件产品，在编码阶段，必须严格贯彻一定的代码开发准则，这会减少程式的隐含错误，同时使程式的内部结构清晰。从而开发出少错误、易维护的优质程式，使得程式的团队合作性和专业化程度大为提高。这是软件开发中公认的一个准则，也是软件工程在编码阶段的一个具体的应用。

一．  程序代码的注释

1．        存储过程的头部注释

每一个存储过程都要写注释，写在最前面。如

/*

Author：              Bill

Create Time：         2003-06-16 17:04

Last Modify Time：     2003-06-16 17:13

Version：                     1.0.01

Action describe：   

Memo：                      

*/

2．        存储过程的代码内部注释

存储过程的内部需要视情况添加注释，简单说明其功能、设计思想、算法等等。如：

/* SET NOCOUNT ON */

3．        CS文件的头部注释

每一个.CS文件都要写注释，写在CS文件的最前面。如

/*

File Name（文件名）：                    ClientServiceS.cs

Storage Path（存储路径）：                Capitalnet_MIS/EntityDAO/

Author（作者）：                         Bill

Create Time（建立日期及时间）：                     2003-06-16 17:04

Last Modify Time（最后修改日期及时间）：  2003-06-16 17:13

File Version（本文件版本号）：X.X.XXX     1.0.01

File Action describe（文件功能描述）：       客户服务实体访问层

File Memo（备注）：

*/

4．        类的注释

为你定义的类写详细的注释，包括作者、时间、版本修订信息、基本的算法，如：

/// <summary>

/// 类的简单描述

/// </summary>

5．        类成员的注释

每一个类的成员，如变量、属性等都要加相应的注释。

6．        方法的注释

为你定义的每一个函数写详细的注释，包括输入输出参数说明、返回值说明、函数功能说明：

/// <summary>

/// 取得本帐期的帐单

/// </summary>

/// <param name="contractGuid">合同Guid</param>

/// <param name="date">本帐期日期</param>

/// <returns>帐单列表</returns>

public static ContractPaidListData CalculateThisPaid(string contractGuid,DateTime date)

{ }

7．        代码内部的注释

关键代码必须加注释，简单说明其功能、设计思想、算法等等。长条注释（划分功能模块）、短条注释（说明实现的各步骤）与句后解释（说明重要句的意义）相结合，清晰功能的实现层次。如：

// Draw the string as normal and let then transforms do the work

/*

This is a test

*/

1)        一般来讲，按需要来注释，简明扼要。

2)        修改代码的注释，当有第二人开始修改代码时，应在每一次修改的代码部分加以注释，必须包括修改人，修改时间，还可以包括修改目的等。

8．        其他要点

1)        对上述较长者在范围结束处加注释。如//for 循环结束 。

2)        注释必须简明扼要，规范易懂。

二．  对象的可访问性设计

1)        不要随意定义类的public，这在基于组件的开发中相当重要。

2)        只有被其他类引用的函数才定义成public型函数。

3)        类中最好不用public型成员变量（一般使用属性来代替）。

4)        最好不使用全局变量。可以使用一些代替的方法。

三．  对象的命名规范

1．        命名要求

1)        所有命名（类、函数、变量..）均要求意义明确易于理解。

2)        避免在代码中直接使用数字等不确定意义的词，尽量使用有意义的串值代替。

例子：Protected Const string CAPTION_TITLE= "Bind Data to a ComboBox"

3)        在名字上区分各种变量及函数。

2．        命名约定

1)        常量命名规则。一般用大写具有意义的复合单词来定义。

                   protected Const string CAPTION_TITLE= "Bind Data to a ComboBox"

2)        字段（变量），开头将一小写字母开头，后面的具有意义的英语单词开始于大写。

               public string strName等

3)        属性，一般用大写字母开头，要具有一定的意义。

              Name;

4)        类名， 以大写字母开头的有意义的复合英语单词。对类名的定义还要考虑到该类的意义。

                   比如我们在项目中分了商务规则层、数据层、商务界面层、数据访问层等。我在下面给出一个Agent表在各层中进行处理的时候相关的类的命名：

AgentData--àAgentS--àAgentR--àAgentF(分别是：数据实体、数据访问层、商务规则层、商务界面层的命名)

5)        控件的命名规则，控件的命名可以以控件的缩写开头（小写），配以一定意义的英文单词；尽量让缩写可以理解。遇到新的控件可以大家讨论来制定。

                 比如：

Button：btnUpate

                   DropDownList: ddlstCity

                   Label: lblName

                   DataGrid : grdAgent

                   DataList : dlstAgent

                   TextBox : txtName

           (等等)       

6)        文件名字的命名，以大写字母开头。DataAccess.cs

 

四．  数据表的定义和功能描述

1)        基础表的定义

基础表是指与业务无直接关系，仅为业务实现提供基础数据的数据库表。这类表有国家（Country）、货币（Currency）、单位（Company）、联系人(Contact)、产品（Product）、银行（Bank）等等。

2)        基础表提供的维护功能

对这些基础表要提供添加、修改、删除、查看等等维护功能。在这些功能中，查看功能是很重要的，要给出多个条件的查看功能的方法，以便别的功能模块的查看和引用的需要。

3)        业务表的定义

业务表则是指与业务直接相关，用以保存各项业务数据、实现各项业务功能的数据库表，这类表有合同（Contract）、项目（Project）、机会（Opportunity）、合同费用（ContractPaidList）等等。

4)        业务表提供的维护功能

对这些业务表要提供添加、修改、删除、查看等等维护功能。因为这些数据与业务息息相关，故要能给出多种查询的方法。这些业务会涉及到大量的业务逻辑，故需使用业务逻辑层对业务表中的数据进行处理。

（未完待续）