读C#代码整洁之道笔记01_C#的编码标准和原则

1.编码原则

1.1.SOLID原则

1.1.1.单一职责原则(Single Respon-sibility Principle)

1.1.1.1.类和方法应当仅具备单一职责。所有组合为单一职责的元素应当组合在一起并进行封装。

1.1.2.开闭原则(Open-Closed Principle)

1.1.2.1.类和方法应当对扩展开放,对修改封闭。

1.1.3.里氏替换原则(Liskov Substitution)

1.1.3.1.若函数接收一个基类的指针,那么该指针应当可以替换为任何从基类派生的类(的指针)而无须事先知晓具体类信息。

1.1.4.接口隔离原则(Interface Segregation Principle)

1.1.4.1.与其设计一个大而全的接口不如拆分为若干小型接口,而类可以选择实现需要的接口中的方法。

1.1.5.依赖倒置原则(Dependency Inversion Principle)

1.1.5.1.高层次的模块不应当依赖低层次的模块。

1.1.5.2.低层次的模块的替换不应当影响高层次模块的使用。

1.1.5.3.不论是高层次的模块还是低层次的模块都应当依赖于抽象。

1.1.5.4.抽象不应当依赖于细节,但是细节应当依赖于抽象。

1.2.YAGNI原则

1.2.1.“你不会需要它”(You Ain't Gonna Need It)

1.2.2.确保类、方法和整体代码行数保持绝对最小水平。

1.3.KISS原则

1.3.1.“保持软件简单易懂”(Keep It Simple,Stupid)

1.3.2.务必要保持代码整洁易读,确保即使是新手程序员也能够理解其含义。

1.4.DRY原则

1.4.1.“避免重复的代码”(Don't Repeat Yourself)

1.4.2.当遇到重复代码时应当尽早将其移除

1.5.奥卡姆剃刀法则

1.5.1.Occam's Razor, Ockham's Razor

1.5.2.“如无必要,勿增实体”,即“简单有效原理”。

1.5.2.1.最简单的方案也最可能是正确的那个方案

1.5.2.2.假设越多,设计方案包含缺陷的可能性就越大

1.5.2.3.项目的构成组件越少,出问题的可能性就越少

2.编码方法

2.1.测试驱动开发(Test-Driven Development,TDD)

2.2.行为驱动开发(Behavioral-Driven Development,BDD)

2.2.1.SpecFlow

2.3.面向方面编程(Aspect-Oriented Programming,AOP)

2.3.1.PostSharp

3.良好代码

3.1.合理的缩进

3.1.1.工具实现

3.2.有意义的注释

3.3.API文档注释

3.3.1.文档越易用,开发人员使用API的意愿就越强

3.4.使用命名空间合理组织代码

3.4.1.使用命名空间合理组织代码

3.5.合理的命名规则

3.5.1.Pascal命名法

3.5.1.1.命名空间、类、接口、枚举和方法

3.5.2.驼峰命名法

3.5.2.1.变量名称、参数名称

3.5.3.在成员变量上必须加上前缀下划线

3.6.一个类执行一种任务

3.7.一个方法做一件事情

3.8.方法的代码少于10行,最好不超过4行

3.8.1.代码格式化、链式函数算1行?

3.9.方法的参数不多于两个

3.9.1.方法最好没有参数

3.9.2.有两个以上的参数时就需要考虑类和方法的职责是不是太多了

3.9.3.方法的确需要两个以上的参数,那么最好将其合并为一个对象参数

3.10.合理使用异常

3.11.代码可读性强

3.12.代码耦合程度低

3.13.高内聚的代码

3.13.1.将公共的功能正确地分组的代码具有高度的内聚性

3.14.对象会被恰当销毁

3.14.1.请务必调用Dispose()方法明确地销毁使用中的资源

3.14.2.将对象(引用)设置为null以使其超出作用范围

3.14.3.using语句

3.15.避免使用Finalize()方法

3.15.1.最好在更加可靠的Dispose()方法中来销毁非托管资源

3.16.合理地进行抽象

3.16.1.当设计只向更高的级别开放,并仅开放必需的内容时,它就处在正确的抽象层次上

3.17.在大型类中使用#region进行区域划分

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

推荐阅读更多精彩内容

  • Clean Code PHP 目录 介绍 变量使用见字知意的变量名同一个实体要用相同的变量名使用便于搜索的名称 (...
    于殿国阅读 147评论 0 0
  • 一、整洁代码 A.混乱的代价 1.有些团队在项目初期进展迅速,但有那么一两年的时间却慢去蜗行。对代码的每次修改都影...
    ZyBlog阅读 2,039评论 0 2
  • 介绍 本文参考自 Robert C. Martin的Clean Code 书中的软件工程师的原则,适用于PHP。...
    零一间阅读 458评论 0 11
  • 前言 文章出处 https://github.com/php-cpm/clean-code-php Clean C...
    石_a41c阅读 692评论 1 5
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,496评论 3 3