代码设计规范

来源：互联网发布：js在线人数编辑：程序博客网时间：2024/06/10 05:54

数据库设计规范
_______________________________________________

表

采用Pascal命名，命名规则同类名一致。

字段

采用Pascal命名，命名规则同属性名一致。

主键

表名+Id

主键要求必须为标识列。

不允许出现复合键作为主键，如有特殊情况请和项目负责人联系。

外键

外键表名+Id

视图

视图名称必须以V_开头作为视图的名称前缀。

所有的数据库业务涉及到多表查询时，必须先创建视图，如视图不能满足要求时请和项目负责人联系。

存储过程

存储过程名称必须以proc_开头作为存储过程名称的前缀，存储过程名称必须使用全部使用大写字母的格式。

所有的数据库业务必须通过存储过程来完成，一律杜绝SQL语句出现在程序中。

触发器
触发器名称必须以trig_开头作为触发器名称的前缀。

在使用触发器解决项目业务时，必须先征求项目主管的意见后方可使用触发器。

其它

最后数据库设计首先考虑性能问题，其次在考虑遵循三大范式的设计规范。

html编码规范__________________________________________

页面名称

所有页面名称包括html,aspx,ascx等等都必须以小写名称命名，不允许使用特殊符号如”_”。

页面内容

每一个页面必须声明DTD，标识出符合w3c的规范。

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

页面标题

所有客户能浏览到的页面必须使用title标签，如：
<title>****</title>

META语句

所有客户能浏览到的页面必须使用meta标签。

1. keywords

2. description

html页面编码方式

所有html页面必须使用下面的格式标识出页面的编码方式。

页面样式

必须使用css文件定义页面样式，如需单独定义页面元素的样式时必须使用style属性或classname属性定义其样式，杜绝使用其他属性定义标签样式，如:bgcolor等等。

JavaScript脚本

页面使用的所有脚本必须采用如下格式声明：

.NET开发的C#编程规范1_________________________________________

C#项目开发编码规范

1.命名空间

框架中所有命名空间的起始部分COM.Tangcheng。
业务中所有命名空间的起始部分COM.Tangcheng.ASSEMBLY.FOLDER。
实际结构和名称以业务为准。

2.类型名称

1)名字应该能够标识事物的特性。

2)名字可以有两个或三个单词组成，但通常不应多于三个。

3)采用Pascal命名，所有单词第一个字母大写。

4)使用名词或名词短语命名类。

5)少用缩写。

6)不要使用下划线字符 (_)。

例：
public class FileStream

public class Button

3.接口

和类命名规范相同，唯一区别是接口在名字前加上“I”前缀。

例：
interface IDBCommand

interface Ibutton

4.枚举
和类命名规范相同，唯一区别是枚举在名字前加上“E”前缀。

例：
enum EsystemType

5.方法

1)使用动词或动词短语命名方法。

2)采用Pascal命名，所有单词第一个字母大写。

6.属性

1)使用名词或名词短语命名。

2)采用Pascal命名，所有单词第一个字母大写。

3)少用缩写。

4)不要使用下划线字符( _ )。

7.成员变量

成员变量起名时要见名实意，采用下面两种命名中的其中一种：

1、采用Camel命名，还要在前面再加“_”前缀。

2、采用Pascal命名，还要在前面再加“m_”前缀。

8.局部变量和形参

局部变量和形参起名时也要见名实意，采用Camel命名,所有单词第一个字母大写，除了首字母小写。（尤其对javascript特别强调必须使用该规范）

还有两个特地方要特别说明：

1)即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然要使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。

2)不要使用原义数字或原义字符串，如for(int i = 1;i <= 7;i++)。而是使用命名常数，如for(int i = 1;i <= NUM_DAYS_IN_WEEK;i++)以便于维护和理解。

9.常量

常量的名字应该都大写，并且指出完整含义，单词之间用下划线（_）分隔。

例：
const int PAGE_COUNT = 10;

10.控件

前台系统开发时，在使用控件时遵循匈牙利命名，格式如下：

控件变量名 = Window控件缩写前缀 + 变量名;

控件类型
命名

Button
btn

CheckBox
chk

ComboBox
cmb

GroupBox
grb

Label
lbl

Panel
pnl

ProgressBar
prog

RadioButton
rad

TextBox
txt

TreeView
tree

Image
img

Time
time

GridView
grid

ListView
lvw

ListBox
list

DropDownList
drp

DataList
list

.NET开发的C#编程规范2______________________________________________

11数组、集合

数组和集合在起名时也要见名实意，在起好的变量名后面加上“s”。

12注释

注释规范包括：类注释规范、类的属性、方法注释规范、代码间注释规范。

12.1类注释规范

类开始必须以以下形式书写类注释：

///<summary>
///类的描述：
///作者：
///创建时间：<格式：YYYY-MM-DD>
///</summary>

12.2类属性注释规范

在类的属性必须以以下格式编写属性注释：

/// <summary>
/// 属性说明:
/// </summary>

12.3方法注释规范

在类的方法声明前必须以以下格式编写注释：

/// <summary>
/// 说明：<对该方法的说明>
/// </summary>
/// <param name="<参数名称>"><参数说明></param>
/// <returns>
///<对方法返回值的说明>
/// </returns>

12.4代码间注释规范

代码间注释分为单行注释和多行注释：

单行注释：

//<单行注释>

多行注释：

/*
多行注释1

多行注释2

多行注释3
*/
13.代码格式规范

1)所有的缩进为4个空格，使用VS.NET的默认设置。

2)在代码中垂直对齐左括号和右括号。

例：
if(x == 0)
{
this.Response.Write("用户编号必须输入！");
}

不允许以下情况：
if(x==0) {
this.Response.Write("用户编号必须输入！");
}
或者：
if(x==0){ this.Response.Write("用户编号必须输入！");}

3)为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏。

4)每一行上放置的语句避免超过一条。

5)在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。

例：
int j = i + k;
而不应写为
int j=i+k;

6)将大的复杂代码节分为较小的、易于理解的模块。

7)相同功能的代码段用＃region折叠起来，在阅读时比较简洁和易于理解。

例：
#region 代码段说明

...

...
#endregion

8) 在类定义中调用本类定义的非静态成员时必须加上自引用this关键字，如：this.Response.Write(“”);；在子类定义中调用父类中定义的非静态成员时必须加上base关键字，如：base.Response.Write(“”);
9) 在类定义中调用本类定义的静态成员时必须加上类名称,如：Person._age;