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

目录：

         前言

         说明性文件规范

         过程注释的规范

         函数的注释规范

命名规范

         设计规范：

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

一．  说明性文件规范(写在每个.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:  // 被修改的表（此项仅对于牵扯到数据库操作的程序）

[1] [2] [3]  下一页