编程规范和范例cle.docx

1、编程规范和范例cle*系统编码命名规范版本 0.1文档类别： 项目管理文档名称： *系统编码命名规范文档标识： 版本： 0.1状态： 讨论稿访问路径： Filevss所有者： cle创建人/创建时间： cle/2004-12-21批准人/批准时间： 修订历史：日 期说 明作 者版 本2004-12-21C#开发和数据库设计的命名规范和约定命名的缩写规范陈利娥1.02004-12-25增加控件命名规范补充HTML编码规范2005-11-4.NET Framework 常规参考 命名指南 陈利娥1.12007-10-6.NET Framework 常规参考 类库开发人员设计指南陈利娥2.0目录一、

2、数据库设计命名规范 5数据库名 5表名 5视图名 5触发器名 5存储过程名 6变量名 6命名中其他注意事项 6二、文件名命名规范 6三、C#开发命名规范 6命名空间的定义 6类 7接口 7枚举和结构 8委派类型，或者叫代理类型 8命名规则 8方法 9属性 9常数 9变量 10注释 10控件 11四、缩写规范 12数据库名和表名 12其他动名词缩写 13五、C# 编码习惯. 142、代码的缩进.要用Tab，而不要用space. 143、尽量不要手工更改机器生成的代码，若必须更改，一定要改成和机器生成的代码风格一样. 144、不准使用goto系列语句. 145、不要声明public的event，应

3、用事件访问器. 146、类型转换的使用规则. 157、生成和构建一个长的字符串时，一定要使用StringBuilder，而不用string. 158、号要新起一行. 159、用 包含if下的语句，即使只有一条语句. 1510、switch语句一定要有default来处理意外情况. 1511、尽量少使用三目运算符 ? : ，而要使用if语句. 1512、尽量不用使用this引用，除非是要调用类中的另一个Constructor. 15六、通用界面规范 161、遵循一致的准则，确立标准并遵循 162、(Color)颜色使用恰当，遵循对比原则： 163、(Resource)资源 174、(Font)字

4、体 175、(Text)文字表达 186、(STYLE)控件风格，不要使用错误控件，控件功能要专一 187、(ALIGN)控件布局，窗口不拥挤，按功能组合控件 188、(TAB ORDER)TAB顺序 199、(ShortcutKey & Accelerator& PopMenu)快捷键、加速键和弹出菜单 1910、(ACTION)用户交互 2011、(HELP)联机帮助： 2012、发行时阐明规则 20七、高开发效率的快捷键 21八、HTML编码规范 21标记的书写 22标记的换行规范 22标记的关闭规范： 22标记的属性值规范 23标记的缩进规范 23注释 24九、NET Framewor

5、k 常规参考 类库开发人员设计指南 24一、数据库设计命名规范数据库名 数据库名：如：JBNET表名 表名必须以名词或名词短语命名，首位大写，同时要使用复数形式，比如： 学生基本信息表：Students 客户基本信息表：Customers 如果是关联表，结尾用Ref表示，关联的实体名称都要列出，这时不用使用复数形式，但每个实体名的首位大写，不要使用下划线，比如： 代理商和客户关联表：AgentCustomerRef 命名应尽量反映存储的数据内容。视图名 视图以v作为前缀，其他命名规则和表的命名类似，比如： 代理商基本信息视图：vAgents 命名应尽量体现各视图的功能。触发器名 触发器名为相应

6、的表名加上后缀，Insert触发器加_i，Delete触发器加_d，Update触发器加_u，如：Customer_i，Customer_d，Customer_u。存储过程名存储过程应以up_开头，和系统的存储过程区分，后续部分主要以动宾形式构成，并用下划线分割各个组成部分。如增加代理商的帐户的存储过程为up_ins_agent_account。变量名变量名采用小写，若属于词组形式，用下划线分隔每个单词，如my_err_no。命名中其他注意事项 以上命名都不得超过30个字符的系统限制。 变量名的长度限制为29（不包括标识字符）。 数据对象、变量的命名都采用英文字符。禁止使用中文命名。二、文件名

7、命名规范文件名要能反应类的内容，最好是和类同名，一个文件中一个类或一组关连类.目录结构中要反应出namespace的层次三、C#开发命名规范命名空间的定义 用有意义的名字命名namespace，如：产品名、公司名. 命名空间必须以名词命名，并按照功能分组，以体现此命名空间的功能，比如：namespace BSS.AccountSys /帐务系统namespace BSS.Entities; /实体类 把引用的系统的namespace和自定义或第三方的用一个换行把它们分开. 用C#预定义的类名，而不要用别名.string userName; 而不是 System.String userName;

8、int number; 而不是 System.Int32;类 以Class声明的类，都必须以名词或名词短语命名，体现类的作用。如： Class Indicator如果通过object builder工具从数据库导出的实体类，使用和表名或视图名相同的名字，如果是视图去掉前面的v，同时使用单数形式，去掉最后的s，如：从表Customers导出类Customer，从视图vAgents导出类Agent。 当类是一个特性（Attribute）时，以Attribute结尾，自定义的属性以Attribute结尾public class AuthorAttribute : Attributeclass Col

9、orSetException 当类是一个异常（Exception）时，以Exception结尾，自定义的异常以Exception结尾，比如：public class AppException : Exception class CauseExceptionAttribute 当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如 class ScreenClass class SystemClass 当类只用于作为其他类的基类，根据情况，以Base结尾： MustInherit Class IndicatorBase 如果定义的类为抽象类，请使用Abstra

10、ct前缀，比如：abstract class AbstractBuilder 如果定义的类是一个窗体，那么名字的后面必须加后缀Form，如果是Web窗体，必须加后缀Page： Class PrintForm : Inherits Form * Windows窗体 Class StartPage : Inherits Page * Web窗体 如果定义的类使用了某些模式，请遵循类名 + 模式名 的规则，比如：工厂模式： class BuilderFactory中介者： class OrderBroker观察者： class AccountObserver等等。接口 接口命名，请遵循COM命名规则

11、：接口必须要由I作为前缀，并用形容词或者名词命名，突出表现实现接口的类将具有什么能力或者角色,比如： interface ISortable : 实现此接口的类可排序，一目了然。interface IDownloadManager: 实现此接口的类可以作为下载管理者使用。 如果要扩展接口，请使用新接口继承原接口，并在后面加2代表是一个扩展接口（不要直接修改原接口，会影响到现有客户的使用），比如：interface IObjectFactory object CreateInstance(Type type);interface IObjectFactory2: IObjectFactory b

12、ool CheckSecurity(Security security);枚举和结构 同样必须以名词或名词短语命名。最好体现枚举或结构的特点，如： Enum ColorButtons 以复数结尾，表明这是一个枚举 Structure CustomerInfoRecord 以Record结尾，表明这是一个结构体 委派类型，或者叫代理类型 普通的委派类型以描述动作的名词命名，以体现委派类型实例的功能： Delegate void DataSeeker (out string SeekString); 用于事件处理的委派类型，必须以EventHandler结尾，如： Delegate void Da

13、taChangedEventHandler (object sender, DataChangedEventArgs e); 6、上述所有规则的共同特点是：每个组成名称的词语都必须是大写开头，禁止完全大写或小写的名称。 命名规则1.用pascal规则来命名方法和类型.public class TextBox public void DataBind() 2.用camel规则来命名局部变量和方法的参数.string userName;public AddUser(string userId, byte password);方法 方法都必须以动词或动词短语命名。方法的命名.一般将其命名为动宾短语.

14、 比如：bool OpenDocument(Document doc); void Print(Document doc);ShowDialog()CreateFile()GetPath()属性 原则上，字段（Field）是不能公开的，要访问字段的值，一般使用属性。属性以简洁清晰的名词命名： public string CustNamepublic Object Current事件事件是特殊的属性，只能在事件处理上下文中使用。命名的原则一般是动词或动词的分词，通过时态表明事件发生的时间： ClickEventHandler Event Click; ColorChangedEventHangl

15、er Event ColorChanged; 常数 文字常量和数字常量不要硬编码，应该用常量类或枚举代替. 常数以表明常数意义的名词命名，一般不区分常数的类型： const float PI = 3.1415; 在严格要求的代码中，常数以c_开头，如c_DefaultConcentration，但最好不要用它，它会带来输入困难。 变量 所有的成员变量前加前缀 _public class Database private string _connectionString; 所有的成员变量声明在类的顶端，用一个换行把它和方法分开 不要声明public和protected的成员变量，应用proper

16、ty. 建议局部变量在最接近使用它时再声明. 局部变量的名称要有意义. 不可使用简称和无意义的名称诸如A，x1，x，y，z等等(除用于For循环变量中可使用i,j,k,l,m,n).下面给出了良好的例子： int Position; string CstomerName; 特殊情况可以考虑一个字母的变量： Graphic g; 多个词的变量每个词首字母应该大写； 不能起太长的名字，应该尽量简洁，如下面的例子： string VariableUsedToStoreSystemInformation; / 错误，太复杂了 string SystemInformation; /正确，简单明了 str

17、ing SysInfo; /错误，过于简单 两个或者多个词组合的变量名过长时，可考虑使用缩写:List CorporationCustomerList; 可缩写为：List CorpCustList; 对于控件，应该指明控件的类型：Button BtnNextPage;Dialog DlgOpenFile; 使用某个控件的值时，尽量命名局部变量.注释关键的语句(包括声明关键的变量)必须要写注释.注释的规则繁多，这里仅提到其中一点：正常的注释以/*/注视片断，单独的/注释单行，只用来注释暂时不用的代码，这样能够方便的采用代码注释工具控制代码的使用。 注释快捷键： Ctrl + k + C取消注释

18、：Ctrl + k + u控件控件类型前缀例子CheckBoxchkchkReadOnlyComboBoxcbocboUserCommandButtoncmdcmdExitCommonDialogdlgdlgFileOpenCommunicationscomcomFaxCSCalendarcsccscCal2DataControldatdatBiblioData-BoundComboBoxdbcdbcLanguageData-BoundGriddbgData-BoundListBoxdblDirectoryListBoxdirDriveListBoxdrvDrop-DownListBoxddl

19、FileListBoxfilFormfrmFramefraGridgrdHorizontalScrollBarhsbImageimgImDateimdImFrame3DimfImMaskimmImNumberimnImTextimxImTimeimtInputDateymdLablelblLinelinListBoxlstListViewlvwMaskEdBoxmedMDIChildFormmdiMenumnuMSFlexGridmsgMSTabmstOLEoleOLECTRAChartochOptionButtonoptPicturepicProgressBarpgbReportrptRic

20、hTextBoxrtfShapeshpSpinspnSpreadsprSlidersldSSCommandcmdSSPanelpnlSSTabsstStatusBarstbTabStriptabTextBoxtxtTimertmrTreeViewtreToolBartlbVBReportvrpVerticalScrollBarvsb四、缩写规范注：希望大家收集我们系统的可以需要缩写的词汇，以下作为参考,请大家先将自己的意见发送给cle，得到确认并加入缩写规范后方可使用数据库名和表名帐户：acct客户：cust代理商：agt产品包：prodpkg产品：prod服务：svc实名：cns排名：kw关

21、键词资源：kwrsc操作员：oper用户名：usrnm密码：pwd报表：rpt会话：session其他动名词缩写名词：实时（帐户）：rt预付款：pp金额：amt余额：bal信用额度：credit价格：price竞价价格：bidprice点击：clk排名名次：pos编号：id编码：cd名词后缀：明细：item详情：dtl信息：info记录：rec状态：st动词：统计：stat竞价：bid转帐：trans收费：charge付款：pay入帐：deposit改变：chg获取：get删除：del插入：ins查询：qry修改：upd检查：chk分配：alloc审核：aprv（approve）终止审核：st

22、opaprv暂停审核（睡眠）pauseaprv恢复审核（唤醒）resumeaprv形容词：每日的：daily每月的：monthly每年的：annually五、C# 编码习惯.1、一行不要超过80个字符.2、代码的缩进.要用Tab，而不要用space.3、尽量不要手工更改机器生成的代码，若必须更改，一定要改成和机器生成的代码风格一样.4、不准使用goto系列语句.5、不要声明public的event，应用事件访问器.public class Source private EventHandler m_NumberChangeEvent; public event EventHandler Num

23、berChangeEvent add m_NumberChangeEvent += value; remove m_NumberChangeEvent -= value; 6、类型转换的使用规则.Animal animal = new Dog();Dog dog = animal as Dog;if (dog != null)7、生成和构建一个长的字符串时，一定要使用StringBuilder，而不用string.8、号要新起一行.public class AuthorAttribute : Attribute9、用 包含if下的语句，即使只有一条语句.10、switch语句一定要有defau

24、lt来处理意外情况.11、尽量少使用三目运算符 ? : ，而要使用if语句.12、尽量不用使用this引用，除非是要调用类中的另一个Constructor.public class Person public Person(string name) public Person() : this(Jim) 六、通用界面规范 1、遵循一致的准则，确立标准并遵循无论是控件使用，提示信息措辞，还是颜色、窗口布局风格，遵循统一的标准，做到真正的一致。 这样得到的好处：1：使用户使用起来能够建立起精确的心里模型，使用熟练了一个界面后，切换到另外一个界面能够很轻松的推测出各种功能，语句理解也不需要费神理解2

25、：降低培训、支持成本，支持人员不会行费力逐个指导。3：给用户统一感觉，不觉得混乱，心情愉快，支持度增加做法：项目组有经验人士，确立UI规范：美工提供色调配色方案，提供整体配色表界面控制程序人员、用户体验人员提出合理统一使用的控件库。参考标准界面使用规范：控件功能遵循行业标准，windows平台参见Microsoft 用户体验(MSDN中有，中文已经翻译发行，项目组必须有一本)控件样式在允许的范围内可以统一修改其样式、色调参考其他软件先进操作，提取对本项目有用的功能，以使用，绝对不能盲从，漫无目的。根据需要，设计特殊操作控件，准则为：简化操作、达到一定功能目的界面实施人员与美工商榷控件可实现性,

26、(如不实行此步骤，将会导致各自对对方工作不满意，也会产生不一致的混乱)。重复叠代上述工作。建立合理化文档UI标准描述上述规范，强行界面设计者理解之，并作为开发准则，SQA人员进行监控开发人员是否遵循，及时告诫开发人员。2、(Color)颜色使用恰当，遵循对比原则：1：统一色调，针对软件类型以及用户工作环境选择恰当色调：如：安全软件，根据工业标准，可以选取黄色，绿色体现环保，蓝色表现时尚、紫色表现浪漫等等，淡色可以使人舒适，暗色做背景使人不觉得累等2：如果没有自己的系列界面，采用标准界面则可以少考虑此方面，做到与操作系统统一，读取系统标准色表3：色盲、色弱用户，即使使用了特殊颜色表示重点或者特别

27、的东西，也应该使用特殊指示符，?quot;!，?着重号，以及图标等4：颜色方案也需要测试，常常由于显示器、显卡的问题，色彩表现每台机器都不一样，应该经过严格测试，不同机器进行颜色测试5：遵循对比原则：在浅色背景上使用深色文字，深色背景上使用浅色文字，蓝色文字以白色背景容易识别，而在红色背景则不易分辨，原因是红色和蓝色没有足够反差，而蓝色和白色反差很大。除非特殊场合，杜绝使用对比强烈，让人产生憎恶感的颜色。 6：整个界面色彩尽量少的使用类别不同的颜色itop色表具体标准参考美术学统计学术标准。 色表的建设，对于美工在图案设计、包装设计上起着标准参考作用，对于程序界面设计人员设计控件、窗体调色起到

28、有章可循的作用。3、(Resource)资源一个多姿多彩的人机交互界面，少不了精美的鼠标光标、图标以及指示图片、底图等。1：也需要遵循统一的规则，包括上述颜色表的建立，图标的建立步骤也应该尽可能的形成标准，参考itop的outlookbar图标设计标准2：有标准的图标风格设计，有统一的构图布局，有统一的色调、对比度、色阶，以及图片风格3：底图应该融于底图，使用浅色, 低对比，尽量少的使用颜色。4：图标、图像应该很清晰的表达出意思，遵循常用标准，或者用户机器容易联想的到物件，绝对不允许画出默认奇妙的图案。5：鼠标光标样式统一，尽量使用系统标准，杜绝出现重复的情况，例如某些软件中一个手的形状就有4钟不同的样子。如：如何创建XP图标附件：Ito