1.1 目的
为了保证企业编写出的程序都符合相同的规范,保证一致性、统一性而建立的数据库命名规范。
编码规范对于程序员而言尤为重要,有以下几个原因:
1. 一个项目的生命周期中,80%的花费在于维护;
2. 几乎没有任何一个项目,在其整个生命周期中,均由最初的开发人员来维护;
3. 命名规范可以改善项目的可读性,可以让程序员尽快而彻底地理解新的代码;
4. 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,比如你已构建的其它任何产品。
为了执行规范,每个软件开发人员必须一致遵守编码规范。
1.2 范围
适合于本项目中编写的命名规则。
1.3 命名原则
1. 使名称足够长以便有一定的意义,并且足够短以避免冗长;
2. 唯一名称在编程上仅用于将各项区分开;
3. 表现力强的名称是为了帮助人们阅读。
因此,提供人们可以理解的名称是有意义的。不过,请确保选择的名称符合适用语言的规则和标准。
1.4 SQL命名规范
·1.4.1 表(Table)命名规范
1. 使用表关键字符+完整的功能英文名称;
2. 不建议使用“_”来连接两个自然名称。
3. 在多个功能英文名称组合时首写字母应为大写;
例:
建议:
UserInfo 基础信息模块中的用户信息
Shopping 购物信息表单
不建议:
tbUserInfo或TB_Userinfo或TBUserInfo
·1.4.2 字段(Column)命名规范
1. 使用 Pascal 大小写来命名字段;
2. 对于公认的缩写使用全大写来命名;
3. 不建议使用“_”来连接两个自然名称。
例:
建议:
UserID 用户ID
UserName 用户名称
不建议:
UserId或Userid
User_Name
·1.4.3 存储过程(Procedure)命名规范
1. 使用表关键字符sp+完整的功能英文名称+By+操作关键字;
2. 关键字符sp与功能名称通过“_”来连接;
3. 对于存储过程的参数,建议与表中字段名一致。
4. 查询关键字为sel,插入关键字为ins,修改关键字为up,删除关键字为del;
例:
sp_selUserInfoByID 通过ID查询单条用户信息
sp_upUserInfoByName 通过用户姓名修改用户详细信息
sp_insUserInfo 插入单个用户信息
·1.4.4 触发器(Trigger)命名规范
1. 使用表关键字符tr+完整的功能英文名称+By+操作关键字;
2. 同存存储过程要求
·1.4.5 视图(View)命名规范
1. 使用表关键字符vw+完整的功能英文名称+By+操作关键字;
2. 同表要求
·1.4.6 函数(Function)命名规范
1. 使用表关键字符ft+完整的功能英文名称;
2. 同表要求。
1.5文件规范1.5.1文件名命名
1. 名字应该能够标识事物的特性;
2. 名字尽量不使用缩写,除非它是众所周知的;
3. 名字可以有两个或三个单词组成,但通常不应多于三个。在名字中,所有单词第一个字母大写,缩写都要大写。不建议使用拼音首字母来组成文件名;
4. 使用名词或名词短语+动词命名文件;例如:UserList.aspx,UserUpdate.aspx
5. 少用缩写;
6. 不要使用下划线字符 (_)。例如:User_Query.aspx
1.5.2文件格式
文件应该按照以下格式顺序来实现:
1. 开头注释
2. 文件名
3. 创建人
4. 日期
5. 描述
6. 版本
例子:
//******************************************************************//
//
//** 文件名: RandomCreator.cs
//
//** 创建人: 张三
//
//** 日 期: 2007/11/29
//
//** 描 述: 主要完成随机数字的生成
//**
//
//** 版 本: 砂子塘社区网 V2.0版
//
//******************************************************************//
using System;
using System.Collections.Generic;
using System.Text;
namespace COMM
{
class RandomCreator
{
}
}
1.5 C#命名规范1.5.1注释(Comment)规范
注释规范包括:模块(类)注释规范、类的属性、方法注释规范、代码间注释。
1.5.2类(Class)命名规范
1. 使用 Pascal 大小写;
2. 用名词或名词短语命名类;
3. 使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML;
4. 不要使用类型前缀;
5. 不要使用下划线字符 (_);
6. 派生类名称的第二个部分应当是基类的名称;
例如:
ApplicationException 对于从名为 Exception 的类派生的类是适当的名称,原因ApplicationException 是一种Exception。
7. 请在应用该规则时进行合理的判断。
例如:
Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件,但是将 Control 作为类名称的一部分将使名称不必要地加长。
1.5.3接口(Interface)命名规范
接口的命名规范同类命名,只是通常在名称前加前缀+“I”。
例子:
public interface IManager
1.5.4参数(Param)命名规范
1. 使用描述性参数名称。参数名称应当具有足够的描述性,以便参数的名称及其类型可用于在大多数情况下确定它的含义;
2. 对参数名称使用 Camel 大小写;
例子:
public ManagerInfo[] GetResultManager(ArrayList alParam,ArrayList alValue)
{
return dc.DriveManager().GetResultManager(alParam,alValue);
}
1.5.5方法(Method)命名规范
1. 使用描述性名称。名称应当具有足够的描述性,以便名称可用于在大多数情况下确定它的含义;
2. 使用动词或动词短语命名方法;
3. 使用 Pascal 大小写。
例子:
public void AddUser(User userInfo)
1.5.6属性(Property)命名规范
1. 使用名词或名词短语命名属性;
2. 使用 Pascal 大小写。
例子:
public Color BorderColor
{
get {}
set {}
}
来自:龙运在线(www.longyun123.com)