【C#】代码书写规范与命名规范

本文介绍了C#代码书写规范,包括使用接口、限制行宽、注释、局部变量声明、避免goto、处理异常、字符串操作、switch语句的默认处理等。同时,概述了命名规范,如Pascal和Camel规则、成员变量前缀、接口命名、方法命名等。此外,还提到了方法修饰符public、static和void的使用,以及标识符的命名规则。
摘要由CSDN通过智能技术生成

代码书写规范:

代码书写规则通常对应用程序的功能没有影响,但它们对于改善对源代码的理解是非常有帮助的。

养成良好的习惯对于软件的开发和维护都是很有益的,下面介绍一些代码书写规则·

1、尽量使用接口,然后使用类实现接口,以提高程序的灵活性;

2、一行不要超过80个字符;

3、尽量不要手工更改计算机生成的代码,若必须更改,一定要改成和计算机生成的代码风格一样;

4、关键的语句(包括声明关键的变量)必须要写注释;

5、建议局部变量在最接近使用它的地方声明;

6、不要使用goto系列语句·除非是用在跳出深层循环时;

7、避免写超过5个参数的方法如果要传递多个参数,则使用结构;

C# 代码编写规范 目录 目录1目的..............................................................................................................................................2 1目的.......................................................................................................................................................4 2适应范围...............................................................................................................................................4 3术语及缩略语.......................................................................................................................................4 4规范内容...............................................................................................................................................4 4.1命名总体规则................................................................................................................................4 4.2命名规范........................................................................................................................................5 4.2.1变量命名.................................................................................................................................5 4.2.2常量命名.................................................................................................................................7 4.2.3类(Class)命名.........................................................................................................................7 4.2.4接口(Interface)命名................................................................................................................7 4.2.5方法(Method)命名..................................................................................................................8 4.2.6命名空间(NameSpace)命名...................................................................................................8 4.2.7属性(Property)命名................................................................................................................8 4.3注释规范........................................................................................................................................8 4.3.1概述.........................................................................................................................................8 4.3.2自建代码文件注释.................................................................................................................9 4.3.3模块(类)注释..........................................................................................................................9 4.3.4类属性注释...........................................................................................................................10 4.3.5方法注释...............................................................................................................................10 4.3.6代码间注释........................................................................................................................... 11 4.4编码规则...................................................................................................................................... 11 4.4.1错误检查规则....................................................................................................................... 11 4.4.2大括号规则........................................................................................................................... 11 4.4.3小括号规则........................................................................................................................... 11 4.4.4缩进规则...............................................................................................................................12 4.4.5对齐规则...............................................................................................................................12 4.4.6比较规则...............................................................................................................................12 4.4.7 Case规则..............................................................................................................................12 4.4.8 If … Else规则.......................................................................................................................12 4.4.9单语句规则...........................................................................................................................13 4.4.10单一功能准则.....................................................................................................................13 4.4.11简单功能准则.....................................................................................................................13 4.4.12明确条件规则.....................................................................................................................13 4.4.13选用False规则..................................................................................................................13 4.4.14独立赋值规则.....................................................................................................................13 4.4.15定义常量规则.....................................................................................................................14 4.4.16模块化规则.........................................................................................................................14 4.4.17交流规则.............................................................................................................................14 4.5编程准则......................................................................................................................................14 4.5.1变量使用...............................................................................................................................14 4.5.2数据库操作...........................................................................................................................14 4.5.3对象使用...............................................................................................................................15 4.5.4模块设计原则.......................................................................................................................15 4.5.5结构化要求...........................................................................................................................15 4.5.6函数返回值原则...................................................................................................................16 4.6代码规范..................................................................................................................................16 4.6.1代码包的版本号...................................................................................................................16 4.6.2代码包的标识.......................................................................................................................16 4.7代码控制......................................................................................................................................17 4.7.1代码库/目录的建立..............................................................................................................17 4.7.2代码归档...............................................................................................................................17 附件1:数据类型缩写表.................................................................................................................17 附件2:控件名缩写表.....................................................................................................................18 a、.NET控件................................................................................................................................18 b、html控件..................................................................................................................................19
评论 37
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值