vb.net 规范

 

vb.net 规范

引言：Kent Beck 曾经说过“我只是个更注重的程序规范的程序员而已”

目录：

     前言

     说明性文件规范

    过程注释的规范

    函数的注释规范

命名规范

    设计规范：

 

 

前言:   1.设计规范的重要性:理由N多, 不在多述

                   2. 本文适用性 :vb.net 开发 asp.net 开发

 

注释代码的目标：

1．叙述清除]代码的作用（是做什么，而不是怎么做）

2． 清楚说明代码所要表达的思想和逻辑

3． 表明代码中的重要转折点

4． 减少代码阅读者在他们大脑中模拟代码的运行

注意：注视应该说明代码的目的，而不要去叙述怎么完成目标的结构，要讲清为什么要那么做，而不是怎么去做

用特殊字符标识注释的作者：‘$      ‘@ 开头的行分别代表不同人写的注释代码

 

一． 说明性文件规范(写在每个.vb结尾的文件头,说明整个文件的功能)

1.1     以’----------------------------------开始和结尾

1.2   File name:    文件名

1.3   Author作者   Version版本:     Date及完成日期:

1.4              Description: 用于详细说明此程序文件完成的主要功能，与其他模块

                  或函数的接口，输出值、取值范围、含义及参数间的控

                 制、顺序、独立或依赖等关系

1.5 Others:       其它内容的说明

1.6 Function List:   主要函数列表，每条记录应包括函数名及功能简要说明

1.7   History: 修改历史记录列表，每条修改记录应包括修改日期、修改

             者及修改内容简述 

    1. Date:

       Author:

Modification:

          2．。。。。。。。。。。。

 

二．  过程注释的规范

2.1     以’----------------------------------开始和结尾

2.2    Description: 功能描述

2.3         Parameters :参数说明

2.4         Calls : 被本过程调用的函数或过程

2.5         Called By:    调用本过程的函数清单

2.6     Table Accessed: 被访问的表（此项仅对于牵扯到数据库操作的程序）

2.7     Table Updated: 被修改的表（此项仅对于牵扯到数据库操作的程序）

 

三．函数的注释规范

3．1 Function:     函数名称

3．2 Description:   函数功能、性能等的描述

3．3 Calls:         被本函数调用的函数清单

3．4 Called By:     调用本函数的函数清单

3．5Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）

3．6 Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）

3．7 Parameters:          // 输入参数说明，包括每个参数的作

                  // 用、取值说明及参数间关系。

3．8 Return:         // 函数返回值的说明

 

四 命名规范

4．   1件命名规范

 

(1)普通控件

名称                  前缀                示例

adrotator           adrt                adrtTopad

button             btn                 btnSubmit

calendar           cal                 calMeetingDates

CheckBox         chk                 chkBlue

CheckBoxList      chkl                chkFavcolors

        CompareValidator   valc                valcValidAge

             CustomValidator    valx                valxDbcheck

                   DataGrid          dgrd                dgrdTitles

                   DataList          dlst                             dlstTiltles

                   DriopDownList    Drop                drop

                   Hyperlink                     link                            lnkDetails

                   Image                            img                 imgAuntBetty

                   ImageButton                 Ibtn                        ibtnSubmit

                   Label             lbl                               lblResults

                   LinkButton                   lbtn

                   ListBox                         lst

                   Panel                   pnl

                   RadioButton                 rad

                   RadopButtonList   radl

                   RangeValidator    valg

                   Regularexpression vale

                   Repeater                    rpt

                   RequiredFieldValidator   valr

                   Table                tbl

                   TableCell                               tblc

                   TableRow                     tblr

                   TextBox                                txt

                   Validationsummary               vals

                   Xml                                        xmlc

(2) ado.net 控件命名

    connction          con                conNorthwind(con +数据库名称)

command                cmd                                     cmdReturnProducts

Parameter                parm                          parmProductId

DataAdapter                         dad                                         dadProducts

DataReader                            dtr                                          dtrProducts

DataSet                                  dst                                          dstNorthwind

DataTable                    dtbl                                        dtblPrpducts

DataRow                               drow                             drowRow98

DataColumn                          dcol                                        dcolProductId

DataRelation                         drel                                         drelMasterDetaril

Dataview                               dvw                                        dvwfilteredProducts

       (3)变量命名的目标：

1． 使变量的用途明确

2． 使每个变量的数据类型和可见范围清晰明了

3． 使代码中的过程易于理解

4． 使程序易于调试

5． 使变量的存储和处理更为有效

 

其余见vb.net 程序设计规范（2）