您好,欢迎访问三七文档
当前位置:首页 > 机械/制造/汽车 > 电气技术 > .Net图片上传程序编码规范
.Net图片上传程序源码及文档下载地址:编码规范本人执行的编码规范:1、除了事件、变量以外其它的命名不要使用“_”,并且事件的“_”必须在事件的名称和事件的操作名称之间。如果有一个或多个单词组成,所有单词的第一个字母大写,单词之间不能有空格,如果有缩略词所有的缩略词大写(包括文件类型名称),但尽量不要有缩略词,如果用尽量一些常见的缩略词如:IBM、AMD、DLL、BLL、JPG、DOC等。缩略词只能在命名的最后出现,不能出现在两上单词之间。2、解决方案、命名空间、类、枚举、函数、属性、数据库、表、视图、存储过程、字段,的命名,如果有一个或多个单词组成,所有单词的第一个字母大写,单词之间不能有空格,缩略词同上。3、参数,如果有一个或多个单词组成,第一个单词全部小写,其它单词的第一个字母大写,单词之间不能有空格,缩略词同上。4、变量,必须加前缀“_”,如果有一个或多个单词组成,所有单词的第一个字母小写,其它单词词的第一个字母大写,并且单词之间不能有空格,缩略词同上,如:string_myName=zhoujian。5、控件,如果有一个或多个单词组成,所有单词的第一个字母大写,单词之间不能有空格,缩略词同上,加上后缀,(实际上微软官方的VisualStudio控件命名规范是加上前缀,前缀的所有字母都是小写,但我更习惯于加上后缀,后缀的第一个字母大写。如:ButtonMyClickBtn=newButton()。参照前缀:(微软官方的VisualStudio控件命名规范),)如果这个控件在没有微软官方的VisualStudio控件命名规范,则如果这个控件开发环境给出的名称有三个或三个以上的单词组成那么加上前三个以上的单词第一个字母的大写如果二个单词组成,则第一个单词的大小字第加上第二的前两个字母,如果只有一个单词组成那么就是这个单词的前三个字母了。委托与事件编码规范(出自网络):1、委托类型的名称都应该以EventHandler结束。2、委托的原型定义:有一个void返回值,并接受两个输入参数:一个Object类型,一个EventArgs类型(或继承自EventArgs)。3、事件的命名为委托去掉EventHandler之后剩余的部分。4、继承自EventArgs的类型应该以EventArgs结尾。类型对内部分组顺序:1、构造函数与终结器。2、变量。3、属性4、声明委托5、声明事件(声明事件:是没有对事件对象初始化,事件对象的值为null;注册事件:是使用“+=”对事件对象初始化,事件对象的值不为null)6、自定义方法。7、事件出自网络:.Net图片上传程序源码及文档下载地址:第一部分简介本文档只适用于C#语言以及其实现的.NETFramework公共类型系统(CTS)一、使用编码规范的目标:定义一些原则以保证编码格式的一致性,提高代码的可读性和可维护性,并保护开发人员尽量减少由编码引起的错误。二、术语和定义1.访问修饰符:publicprotectedinternalprivateC#中大多数成员使用private,而借口和枚举默认的访问修饰符为public2.骆驼命名法第一个单词的首字母小写,后续各单词的首字母均大写。例:depName3.公共类型系统.NETFramework公共类型系统(CTS)定义如何声明、使用和管理类型。所有本地的C#类型都基于CTS,支持跨语言集成。4.标识符自定义的标记,用于唯一命名对象或对象实例例:publicclassMyclassOfPersonal{}5.帕斯卡命名法第一个单词首字母大写,后续个单词的首字母也大写。三、命名总则1.命名惯例:c表示骆驼命名法p表示帕斯卡命名法–表示下划线为前缀标识符publicprotectedinternalprivate说明项目文件p与程序集和命名空间匹配源文件p与包含的类匹配其他文件p在可能的位置使用命名空间p与项目/程序集部分匹配类或结构pppp为子类添加后缀接口pppp用大写字母I作前缀方法pppp使用动词或动词与对象组合属性pppp不要用Get或Set做前缀字段ppp_c只使用private字段,不使用胸牙利命名法常量ppp_c静态字段ppp_c只使用private字段枚举pppp枚举符中的可选项也必须符合帕斯卡命名法委托pppp事件pppp参数c2.编码风格代码风格源文件每个文件有一个命名空间和一个类大括号位于新行,可选时始终使用括号.Net图片上传程序源码及文档下载地址:缩进使用大小为4的制表符注释使用//或///,不使用“…”,也不使用星号框注释方法变量每个声明有一个变量3.语言用法本地数据类型使用内置C#本地数据类型与.NETCTS类型,例如使用int而不是Int32枚举避免更改默认类型属性不要用Get或Set做前缀方法最多是用7个参数base和this仅用于构造函数或重写中foreach语句不要修改foreach语句中的枚举项条件避免针对true或false计算布贰条件;不使用嵌入式赋值;避免调用嵌入式方法异常:不得将异常用于流控制;重新引发是使用throw;而不是throwe;只捕获可以处理的内容;使用验证以避免发生异常;从Execption而不是ApplicationException中派生事件调用前始终检查是否为nullDispose()和Close()如果提供了这些方法,则始终对其进行调用,并在需要的位置进行声明程序集版本手动递增第二部分命名惯例命名惯例:一致性—是可维护代码的关键。对于命名项目、源文件和标识符(如字段、变量、属性、方法、参数、类、接口、和命名空间),要确保命名的一致性。一、一些通用的规则1.始终使用骆驼命名法或帕斯卡命名法。2.避免使用全部大写和全部小写的名称,单个小写单词或字母是允许的。3.不要创建只按照大写而改变的命名空间、类、方法、属性、字段或参数。4.不要使用以数字字符开头的名称。5.选择有意义且特定的名称。6.尽量使用详尽而不过于简洁的命名。7.变量和属性应该描述实体而不是类型或大小。8.不推荐使用匈牙利命名法。9.避免使用缩略语,除非全程过长。10.避免使用超过5个字符的缩略语。11.所有的缩略语都必须为大家所熟知和接受。12.对两个字母的缩略语使用小写,而对较长的缩略语使用帕斯卡命名法。13.不使用C#保留字作为名称。14.避免命名与现有.NETFramework命名空间或类型冲突。15.避免向标识符添加冗长或没有意义的前缀和后缀。16.不要在属性名称中包含父类名称。17.尽量将CanIsHas用做布尔变量和属性的前缀。.Net图片上传程序源码及文档下载地址:在适当的地方将计算限定符附加给变量名称,如Average、Count、Sum、Min、Max19.定义根命名空间时,请将产品名、公司名或开发人员姓名作为根。二、名称用法与语法项目文件:帕斯卡命名法。始终将程序集名称与根命名空间匹配。源文件:帕斯卡命名法,始终将类名与文件名匹配。避免每个文件包括多个类、枚举(全局)或委托(全局)。包含多个类、枚举或委托时,使用描述性文件名。资源或嵌入式文件:尽量使用帕斯卡命名法。使用描述文件内容的名称。命名空间:帕斯卡命名法。尽量与醒目/程序集名称部分匹配。类或结构:帕斯卡命名法。用名词或名词短语作为类名称。如果可能,在为其他类型划分子类是添加相应的类后缀。接口:帕斯卡命名法。用大写字母I作为接口名称的前缀。方法:帕斯卡命名法。尽量使用动词或动词与对象组合。属性:帕斯卡命名法。属性名称应该表示其返回的实体。绝对不要将Get或Set用作属性名称的前缀。字段(Public、Protected或Internal):帕斯卡命名法。避免使用非private字段!请使用属性。字段(Private):使用骆驼命名法,并用单个下划线字符“_”作为前缀。常量或静态字段:作为字段处理,选择以上响应的字段访问修饰符。枚举:使用帕斯卡命名法(类型和选项)。委托或事件:作为字段处理,选择以上相应的字段访问修饰符。参数:骆驼命名法。第三部分编码风格编码风格:以下描述实现C#源代码推荐的方法,以便创建易于理解、易于维护、可读性强、结构清晰并且前后一致的代码。一、格式设置:1、每个文件不要生命多个命名空间。2、避免在单个文件中放置多个类。3、将大括号{和}放置于新行。4、在条件语句中使用大括号{和}。5、使用大小为4的制表符和缩进。6、独立声明每个变量,即不在同一个语句中声明多个变量。7、将命名空间和using语句置于文件顶部。将命名空间分组为.NET命名空间和自定义命名空间。8、按照以下顺序按类型对内部类进行分组。1、构造函数与终结器。8、成员变量。9、声明委托10、声明事件(声明事件:是没有对事件对象初始化,事件对象的值为null;注册事件:是使用“+=”对事件对象初始化,事件对象的值不为null)11、属性12、自定义方法。13、事件.Net图片上传程序源码及文档下载地址:、根据访问修饰符和可见性为类型中的序列声明分组。publicprotectedinternalpricate10、将文件夹名称附加到子文件夹内源文件的命名空间。11、递归缩进括号内包含的所有代码块。12、使用空白(回车符/换行符、制表符等)分割和组织代码。13、将程序集范围的属性声明放置于一个单独的行。14、将类型范围的属性声明放置在一个单独的行。15、将方法范围的属性声明放置在一个单独的行。16、将成员范围的属性声明放置在一个单独的行。17、将参数属性是声明于参数内联。18、如果存有疑问,结构清晰、前后一致为原则。二、代码注释1、使用//或///,不使用/*….*/。2、不使用星号框注释方法。3、不要使用行内注释解释明显易懂的代码,质量高的编码具有自解释性能。4、始终为public、protected和internal声明应用C#注释块(//)第四部分语言用法一、一般用法1、不要省略访问修饰符。用相应访问修饰符显式声明所有标识符,而不允许显式声明默认值的标识符。2、不要使用默认的(“1.0.*”)版本控制模式。手动增加AssemblyVersionAttribute值。3、将所有程序集的ComVisibleAttibute设置为false。然后,选择性地对需要的单个类启用ComVisibleAttribute。4、避免程序集之间的相互引用。二、变量和类型1、尽量在声明变量的语句中将变量初始化。2、使用要求的最简单的数据类型、列表或对象。例如,一般使用int类型,除非知道需要存储64位的值,才使用long类型。3、始终使用内置C#数据类型别名,而不是.NET公共类型系统(CTS),包括:使用short不用System.Int16使用int不用System.Int32使用long不用System.Int64使用string不用System.String4、只是将成员变量声明为private,使用属性为带有public、protected或internal访问修饰符的变量提供访问。5、避免为enum指定类型。除非显式需要long类型,否则使用默认的int类型。6、避免声明内联字符串常数,而是使用常量、资源、注册表或其他数据资源。7、只为简单类型生命常量。8、为复杂类型声明只读或静态只读变量,而不声明常量。.Net图片上传程序源码及
本文标题:.Net图片上传程序编码规范
链接地址:https://www.777doc.com/doc-11861071 .html