C# 编程规范-基本要求

本文介绍了C#编程的基本规范,包括程序结构清晰、注重可读性、遵循结构化原则、确保正确性和容错性,以及提倡代码的可重用性。强调函数长度不超过100行,注释与代码同步,避免使用GOTO语句,输入合法性检查,以及将可复用代码抽象为ASP.NET服务或类。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

C#编程规范基本要求如下:

1.程序结构要求

  • 程序结构清晰,简单易懂,单个函数的程序行数不能超过100行。
  • 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
  • 尽量使用.NET库函数和公共函数(无特殊情况不要使用外部方法调用Windows的核心动态链接库)。
  • 不要随意定义全局变量,尽量使用局部变量

2.可读性要求

  • 可读性第一,效率第二(代码是给人读的,不要写别人看不懂的代码)。
  • 保持注释与代码完全一致。
  • 每个源程序文件,都有规范的头文件说明。
  • 每个函数都有函数头说明。
  • 主要变量(结构、类或兑对象)定义或引用时,注释能反映其含义。
  • 处理过程的每个阶段都有相关注释说明。
  • 在典型算法前都有注释。
  • 利用缩进来显示程序的逻辑结构,缩进量一致并以TAB键位单位,定义TAB为6个字节。
  • 循环、分支层次不要超过5层。
  • 一目了然的语句不加注释。
  • 注释行数应占总行数的1/5到1/3。

3.结构化要求

  • 禁止出现两条等价的支路。
  • 禁止使用GOTO语句。
  • 避免从循环引出多个出口
  • 函数只有一个出口
  • 避免使用条件赋值语句。
  • 不要轻易的用条件分支取替代逻辑表达式。

4.正确性与容错性要求

  • 程序首先必须正确,其次才是优美
  • 改一个错误可能产生新的错误,所以在你修改之前首先考虑对其他部分的影响。
  • 对所有用户的输入,必须进行合法性检查

5.可重用性要求

  • 重复使用的完成相对独立功能的算法或代码应抽象为ASP.NET服务或类。
  • ASP.NET服务或类应考虑OO思想,减少与外界联系,考虑独立性和封装性。

                                                                                                                                         文章参考资料:《亮剑.NET》

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
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值