C#代码编写规范和相关约定(一)

本文介绍了C#代码的编写规范,强调了.NET框架中Pascal和Camel命名规则的使用,如类名、方法名等采用Pascal规则,参数和私有变量采用Camel规则。同时,建议避免使用匈牙利命名法,并讨论了大小写敏感性和同名覆盖的编写技巧。
摘要由CSDN通过智能技术生成

    C#的编码书写规范是编写代码的关键所在,想写出幽雅整洁的C#代码并不是件困难的事情,Microsoft公司的.Net开发小组已经给我们呈现出一套很完整的书写规范,那么让我们看看这些代码书写风格。 

    一 : 标识符命名约定

    C#中对标识符的命名主要采用Pascal命名规则和Camel命名规则,这里要值得注意的是很多Visual Basic和Visual C++程序员还是习惯采用匈牙利命名规则,在.Net框架中所有的可执行部分是在CLR的托管下运行的,所以可以说其数据的安全性可以得到保障,没有必要在每个标识符前加上数据类型前缀,因此整个.Net框架下只采用Pascal和Camel两种命名规则。

    Pascal命名规则表明所有英文单词的首字母大写其它字母小写.  for example : MyWorker

    Camel命名规则表明所有的英文单词除第一个单词首字母小写外其它首字母一律大写.  for example : myBookName

    C#中对类名(Class Name),方法名(Method Name),属性名(Property Name),事件名(Event Name),自定义委托,结构体,自定义枚举等应该采用Pascal命名约定,而方法的参数名,私有的成员变量名或字段名都应该采用Camel命名约定。

    C#对大小写是敏感的myName和MyName是不一样的这点要注意,正因为C#是大小写敏感的编程语言所以在C#的类代码书写过程中常常采用属性同名覆盖的写法。Microsoft给出的一个忠告是在变量命名的过程中不要使用(_)来修饰标识符,但我个人认为私有属性同名字段可以采用(_)开头这样更容易区分各同名标识符。

    for example :

using  System;

namespace  CodeStyle
{
    
public sealed class Customer
    
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
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、付费专栏及课程。

余额充值