- 1、本文档共15页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
PAGE1/NUMPAGES1
代码书写规范V1.0.0(C#)
代码书写规范撰写时间:
撰写人(签字):
审批人(签字):
审批日期:
变更记录版本号修改点说明变更人存放位置审批人审批日期目录前言5一.命名规则5a)命名空间命名规则51.拼写规范52.命名空间划分5b)类命名规则61.拼写规范6二.书写规范6c)类成员变量命名规则6d)控件命名规则6e)枚举和结构命名规则6f)方法命名规则7g)属性命名规则7i)局部变量命名8j)接口的命名9三.注释书写规范9k)命名空间注释9l)类注释9m)类成员变量注释10n)方法注释10o)内部注释10四.代码页面布局规范10p)代码格式111)缩进112)折行113)分区11五.代码书写规范11六.数据库操作12七.其它规定12附录A:
名称空间申报表13附录B:
常用控件命名规则14附录C:
代码规范样例16前言为了方便本项目组成员之间的沟通与交流,增强系统设计过程的规范性,在此规定代码书写规范。
自此规范发布之日起后开展的项目,规范中强制性条款需要严格遵守。
规范在执行过程中如产生有争议的条款,通过会议讨论进行统一。
一.命名规则a)命名空间命名规则1.拼写规范命名空间的名称拼写采用Pascal形式,首字母大写,其它字母小写。
大写单词首字母作为分隔,例如:
RailwayStation。
名称应当为能够表示中文意义的英文单词组成。
如果采用缩写,缩写字母必须使用大写方式。
除人名、地名外,不允许使用中文拼音。
命名空间的名字不能过长,原则上不超过20个字母。
2.命名空间划分每一个项目只存在一个主命名空间,例如ESINT.XXX。
项目下的各个子项目的名称空间由各项目组自行定义,但必须在命名空间申报处申报,例如ESINT.XXX.Model命名空间。
如果项目组采用三层结构模式模型开发项目,则各层结构的名称空间必须以如下方式命名:
ESINT.XXX.DAL(数据访问层),ESINT.XXX.BLL(业务逻辑层),ESINT.XXX.Model(实体层),ESINT.XXX.Web(B/S表示层),ESINT.XXX.Utility(公用函数层),ESINT.XXX.Form(C/S表示层),XXX为各项目的名称.严禁在项目中使用未申报的命名空间。
名称空间申报表结构见附录Ab)类命名规则1.拼写规范类名拼写采用Pascal形式,首字母大写,其它字母小写。
大写单词首字母作为分隔,例如:
RailwayStation。
名称应当为能够表示中文意义的英文单词组成,尽量不使用缩写。
类名称应当为名词或者为形容词+名词。
除人名、地名外,尽量不使用中文拼音。
类名不能过长,原则上不超过20个字母。
二.书写规范一个文件中(.cs文件)中只能包含一个类。
c)类成员变量命名规则对于类私有成员变量名采用Camel拼写方式。
首字母为小写,名字前加_。
如:
privatestring_firstName;类不能使用非私有的成员变量。
应当通过属性的方式对外公开内部成员。
d)控件命名规则控件成员作为一个特例采用匈牙利命名法,前三位为缩写,常用缩写详见:附录Be)枚举和结构命名规则枚举和结构采用Pascal拼写方式。
对于枚举类型,不仅枚举类型名采用Pascal拼写,枚举选项同样采用Pascal拼写。
例如:
publicenumCustormerType{Consumer,Commercial}f)方法命名规则方法采用Pascal拼写方式。
名称以英文单词组成。
采用动词或动词+名词的形式,动宾短语形式。
如:
您可能关注的文档
- 大病救助申请书_3.docx
- 电力承诺书集合3篇.docx
- 第4章 第4节 协调人地关系的主要途径.doc
- 胆宁片治疗非酒精性脂肪肝安全性和有效性临床研究肝气郁滞、湿热内蕴证研究.doc
- 冬至安好问候语.docx
- 地理高一必修同步训练题四川省.doc
- 大学生个人自我介绍大全.docx
- 创建文明社区申报材料.docx
- 中药化学全套教学课件.pptx
- 《无人机测绘技术》全套教学课件.pptx
- 2024精简护肤洁面趋势报告-TMIC-30正式版.doc
- 2024捕捉华夏民族珍味-咸味主食与咸味零食创新机遇报告-25正式版.doc
- 2024年秋季部编版小学道德与法治二年级上册全册课件PPT最新.pptx
- 部编版第十一册第四单元拓展提高教学课件.ppt
- 2024年秋季新西师大版一年级上册数学全册教学课件(新版教材).pptx
- 2024年秋新人教版一年级上册数学全册教学课件(新版教材).pptx
- 2024年秋季新人教版数学一年级上册全册教学课件(新版教材).pptx
- 2024年秋季新人教版数学一年级上册全册课件(新版教材).pptx
- 2024年秋季新人教版一年级上册数学全册教学课件(新版教材).pptx
- 2024年秋季新人教版一年级上册数学全册课件(新版教材).pptx
文档评论(0)