c#软件开发编码规范

c#软件开发编码规范

ID:14889585

大小:43.00 KB

页数:7页

时间:2018-07-30

c#软件开发编码规范_第1页
c#软件开发编码规范_第2页
c#软件开发编码规范_第3页
c#软件开发编码规范_第4页
c#软件开发编码规范_第5页
资源描述:

《c#软件开发编码规范》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库

1、类书写标准(C#/VB.NET)Ver:1.1顶部声明内容2方法位置3#Region使用5变量初始值6变量命名7顶部声明内容文件的顶部可以包含文件的测试数据、注释、作者、创建时间、修改人、修改时间。但不强行规定。但涉及到数据的,需要包含测试数据。注释以//的方式添加多个单行注释。//作者:吴亚喆(wyz)//创建时间:2008-8-14//修改人:吴亚喆//修改时间:2008-8-15//功能:消息管理器方法位置方法需要将相关的内容归类在一起。我们分为下面几个部分:1.delegateandsu

2、btype2.field3.property4.ctor,init,dtor5.method6.function这里6个部分表示了一个类最复杂情况所包含的内容。把相关内容放在一起也利于我们自己查找和维护。下面介绍一下每个部分应该书写什么内容。delegateandsubtype类中用到的委托,或者子类型的声明,子类型不要声明为平级,而是声明为包含的类。field成员变量,尽量的都声明为私有,事件声明为其他访问级别。property属性书写在这里,属性的访问器get和set的访问级别可以不一样,例

3、如publicintIntProperty{publicget{returnintVar;}internalset{intVar=value;}}cotor,init,dtor构造函数,初始化和释放。如果是窗体,对应的OnLoad,OnHandleCreate,OnActive的方法,Form1_Load,Form1_Active的事件响应方法应当卸载这里。如果是控件,对应的OnLoad,OnHandleCreate,OnActive,OnParentChanged的方法应当写在这里。如果是一般

4、的类,Dispose接口的实现,析构函数,释放函数都应当写在这里。method书写类对外的主要接口方法,例如Open,Close,Write,Read之类,对象直接的抽象。function书写可能重复的方法,例如多个Open方法都要做CheckOpenStatus,这个操作用户不会直接使用,或者不常用,则写在这里。模板类:/*注意事项:*/usingSystem;usingSystem.Collections.Generic;usingSystem.Text;namespaceZHD{publi

5、cclassClass1{#regiondelegateandsubtype#endregion#regionfield#endregion#regionctor,init,dtorpublicClass1(){}#endregion#regionproperty#endregion#regionmethod#endregion#regionfunction#endregion}}#Region使用Region表示相关的内容,避免分类过细,请按照前一部分列出的进行分类。函数内部或者类的内部,可以

6、嵌套region使用。尽可能的使用此标签折叠相关内容。折叠的好处是我们可能打开某个部分。先看到每个region,对程序有个认识,然后根据需要展开具体的块。如果需要全部展开,可以使用快捷键:ctrl+m,ctrl+o。变量初始值变量分2种,类成员变量和方法的局部变量。成员变量:尽可能的在声明处初始化,但不要进行多余的初始化,例如对数值类型变量赋值为0,对引用类型变量赋值为null。这样会多一条IL的汇编语句,并不会带来实际意义。对于需要在运行时构造的,编写构造函数,并在多个构造函数的情况下,通过调

7、用来初始化,不要赋值代码。局部变量:主动释放自己分配的非托管资源。变量命名类型的缩写+功能,例如,创建一个窗体,就起名为:frmRoad。frm为前缀,form的缩写,Road是功能,第一个字母小写,好处是frm小写,人们注意力首先会看到大写字母,能看到功能描述的单词,然后才关注frm。突出重点。也能从变量名知道是什么类型的。类名的命名:1.窗体。控件类,需要在前面写类型,例如:frmRoad,ctlSurveyComputer。2.功能形类,无特殊要求,除非行业有缩写的拼音,否则禁止使用拼音命

8、名。3.窗体内,尽量不使用默认的名称,除非窗体非常简单。只有2个按钮,分别是OK,Cancel,不用编写任何实现或者不用引用。则可以使用默认名称,只修改DialogResult部分。Label,如果不需要修改,也可以不重命名使用系统的默认名称。如果反复使用的,不能出现MenuItem1....MenuItemn或者ComboBox1,Button1之类的。可以使用缩写,例如:MenuItemConnect避免写的太长,可以缩写为:menuConnect或者miConnect,buttonTest

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。