C#命名规则和编码规范

  • 用Pascal规则来命名属性、方法、事件和类名。
 public class HelloWorld
 {
     public void SayHello(string name)
     {
     }
 }

Pascal规则是指名称中单词的首字母大写 ,如EmployeeSalary、 ConfimationDialog、PlainTextEncoding。

  • 用Camel规则来命名成员变量、局部变量和方法的参数。
 public class Product
 {
     private string productId;
     private string productName;

     public void AddProduct(string productId,string productName)
     {
     }
 }

Camel规则类似于Pascal规则 ,但名称中第一个单词的首字母不大写 ,如employeeSalary、 confimationDialog、plainTextEncoding。

  • 不要使用匈牙利命名法。不要给成员变量加任何前缀(如、m、s_等等)。如果想要区分局部变量和成员变量,可以使用this关键字。

  • 不要将常量或者只读变量的变量名全部大写,而使用Pascal规则来命名。

 // Correct
 public static const string ShippingType = "DropShip";

 // Avoid
 public static const string SHIPPINGTYPE = "DropShip";
  • 接口的名称一般以大写I作前缀。
 public interface IConvertible
 {
     byte ToByte();
 }
  • 自定义的属性以Attribute结尾。
 public class TableAttribute:Attribute
 {

 }
  • 自定义的异常以Exception结尾。
 public class NullEmptyException:Exception
 {

 }
  • 类的命名。用名词或名词短语来命名类名。
 public class Employee
 {
 }
 public class BusinessLocation
 {
 }
 public class DocumentCollection
 {
 }
  • 方法的命名。一般将其命名为动宾短语。
public class File
 {
     public void CreateFile(string filePath)
     {
     }
     public void GetPath(string path)
     {
     }
 }
  • 局部变量的名称要有意义。不要直接用用i,j,k,l,m,n,x,y,z等做变量名,但for循环除外。

  • 所有的成员变量声明在类的顶端,用一个换行把它和方法分开。同时可以使用成对的#region...#endregion标记,方便折叠。

  • 布尔型变量或者方法一般可以用iscan或者has做前缀。如,isFinished, canWork等。

  • 一般C#的编码风格要求花括号{另起一行,不要直接跟在类名和方法后面。

public Sample()
{
   // TODO: 在此处添加构造函数逻辑
}
  • 可以用缩写作为UI元素的前缀。常见UI组件的一般缩写形式:
Label --> lbl、Text --> txt、Button --> btn
Image --> img、 Widget --> Wgt、 List --> lst、CheckBox --> chk
Hyperlink --> lnk、Panel --> pnl、Table --> tab
ImageButton --> imb
  • 判断条件是一个布尔变量时不要使用==进行条件判断。
// 不友好的写法
private bool isFinished = true;
if(isFinished == true)
{
    // ...
}
// 正确的写法
private bool isFinished = true;
if(isFinished)
{
    // ...
}
  • 变量名是一个单词的尽量不要缩写,多单词组成的变量名可适当缩写。

  • 在类的顶部声明所有的成员变量,静态变量生命在最前面。

// Correct
public class Account
{
    public static string BankName;
    public static decimal Reserves;

    public string Number {get; set;}
    public DateTime DateOpened {get; set;}
    public DateTime DateClosed {get; set;}
    public decimal Balance {get; set;}

    // Constructor
    public Account()
    {
        // ...
    }
}
  • 如果一个方法超过25行,就需要考虑是否可以重构和拆分成多个方法。方法命名要见名知意,好的方法名可以省略多余的注释。方法功能尽量单一。

参考文章:
http://www.dofactory.com/reference/csharp-coding-standards
https://blogs.msdn.microsoft.com/brada/2005/01/26/internal-coding-guidelines/

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,907评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,546评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,705评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,624评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,940评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,371评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,672评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,396评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,069评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,243评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,847评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2 259

推荐阅读更多精彩内容

  • 1. 用Pascal规则来命名属性、方法、事件和类名 Pascal规则是指名称中单词的首字母大写 ,如Employ...
    Sheh伟伟阅读 23,580评论 6 26
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,087评论 18 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,292评论 18 399
  • Objective-C-Coding-Guidelines-In-Chinese Objective-C编码规范,...
    LD_X阅读 543评论 0 6
  • 你见过患者咨询完医生就去给自己开刀动手术的吗?我在电影里见过,基本场景就是某人因被警察通缉,无法去医院,最后很痛苦...
    刘建强阅读 292评论 0 0