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