您的位置:首页 > 运维架构 > 网站架构

《ASP.NET网站开发》系列笔记(1)——编程规范(续)

2010-04-28 09:47 309 查看
3)参数的命名规则
只读和Const字段用名词、名词短语或名词的缩写命名。静态字段用Pascal大写命名。注:一、使用描述性参数名,二、不要使用保留参数
4)方法命名原则
用动词或动词短语命名方法。如RemoveAll(),GetCharArray(),Invoke()
5)事件的命名原则
用EventHandler后缀命名事件处理程序,如public delegate void MouseEventHadler( object sender, MouseEvent e),使用Sender 和e两个参数,Sender参数代表提出事件的对象,它永远是一个类型对象,即使它可能使用了更为特定的类型。与事件相关的状态被封装在一个名为e的事件类范例中。要使用这个类型的正确的、特定的事件类。用EventArgs后缀命名事件自变量类,如下所示:public class MouseEventArgs:EventArgs{

int x;
int y;
public MouseEventArgs(int x ,int y)
{
this.x=x;this.y=y;
public int X{get { return x;}}
public int Y{ get {return y;}}
}
6)控件的命名原则
命名要求:变量名=类型缩写前缀+变量名含义名词,其中,类型缩写前缀要求全小写,变量名含义名词采用Pascal规范。如 TextBox来显示学生学号,可写为:txtStuName.
2、注释编写规范
注释,广义上来说包含了对软件注解的一切文档,因此,可分为内部注释和外部注释。在程序中,内部注释分为三类:
(1) 文件头注释
一般的格式是:
////////////////////////////////////////////
///文件名
///Copyright (c)
///创建人
///日期
///修改人
///描述
///版本
//////////////////////////////////////////
它可以帮助了解该文件的一般意义。
(2) 函数体注释
函数体注释的一般格式是:
////////////////////////////////////////////
///<summary>
///功能注释
///</summary>
///<param name=”参数名”>这里写函数参数的定义</summary>
///<returns>函数返回值</returns>
//////////////////////////////////////////
功能注释的表达很重要,对于一个函数如GetWishes(bool radom)注释时,可以这样写根据ramdom选择是否以随机的方式返回希望列表。
(3) 语句功能注释
在语句后,同行加“//”来进行注释,多行用“/**/”来进行处理。一般有几个要点:1)清楚明白的地方,不加注释2)逻辑判断多的地方,要加注释3)加注释必须要易懂4)好的注释应从流程角度出发,而不是见文生义。
3、数据库编码规范
一、数据库对象的命名规范
1)表名、视图名:项目名+实体名
2)存储过程名:表名(或其实被操作的对象名)+“_”+操作方法名,如WishesLog_Create.
3)存储过程注释书写规范
如下所示:
-------------------------------------------------------------------
-----用途:
-----作者:
-----时间:
-----
--------------------------------------------------------------------
存储过程内容
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: