亚洲必赢76net的主页读 《CSharp Coding Guidelines》有感

类设计指南

  • 一个类/接口应该只有一个用途,要符 合单一职责 原则;
  • 只创建返回有用对象的构造函数,当构造函数的参数超过 3
    的话,你就应该考虑你的类设计是否过于臃肿;
  • 接口应该短小精悍,其定义要明确清晰地传达出其具有的行为;
  • 如果一种行为有多种实现,请考虑使用接口而不是基类;
  • 尽量使用接口将类进行彼此解耦;
  • 避免使用静态类;
  • 不要使用 new 关键字来禁止编译器显示相关警告;

public class Book
{
    public virtual void Print()
    {
        Console.WriteLine("Printing Book");
    }
}

public class PocketBook : Book
{
    public new void Print()
    {
        Console.WriteLine("Printing PocketBook");
    }
}

class Program
{
    static void Main(string[] args)
    {
        PocketBook pocketBook = new PocketBook();
        pocketBook.Print();

        ((Book)pocketBook).Print();

        Console.ReadKey();
    }
}

在上述代码段中,我们创建一个基类 book,并定义了一个 Print()
方法,接着我们创建一个子类 PocketBook,并通过 new
关键字来重写基类方法。在项目复杂的情况下,使用这种方式将导致我们不能准确预测是子类调用还是父类调用,使代码复杂度提升。

  • 应该可以将派生类当作基类对象来处理;
  • 不要引用基类的派生类;
  • 避免暴露一个对象依赖的其它对象;
  • 避免双向依赖;
  • 类应该有状态和行为;
  • 类应该保护其内部状态的一致性;

    图灵程序设计丛书:精通C#
目录:

C# 编程指南

第四部分 高级C#编程结构
第9章集合与泛型
9.1
集合类的动机
9.1.1
System.Collections命名空间
9.1.2
System.Collections.Specialized命名空间
9.2
非泛型集合的问题
9.2.1
性能问题
9.2.2
类型安全问题
9.2.3
初识泛型集合
9.3
泛型类型参数的作用
9.3.1
为泛型类/结构指定类型参数
9.3.2
为泛型成员指定类型参数
9.3.3
为泛型接口指定类型参数
9.4
System.Collections.Generic命名空间
9.4.1
集合初始化语法
9.4.2
使用List类
9.4.3
使用Stack类
9.4.4
使用Queue类
9.4.5
使用SortedSet类
9.5
System.Collections.ObjectModel命名空间
9.6
创建自定义泛型方法
9.7
创建自定义泛型结构和类
9.8
类型参数的约束
9.8.1
使用where关键字的示例
9.8.2
操作符约束的不足
9.9
小结

前不久在 Github
上看见了一位大牛创建一个仓库:CSharpCodingGuidelines,打开之后看了一下
readme.md 相关描述,感觉应该很不错,于是就 clone
到本地拜读一下,这里列一些自己的笔记,方便日后回顾。

第2章 构建C#应用程序
2.1
.NET Framework 4.5 SDK的作用
2.2
用csc.exe构建C#应用程序
2.2.1
指定输入输出目标
2.2.2
引用外部程序集
2.2.3
引用多个外部程序集
2.2.4
编译多个源文件
2.2.5
使用C#响应文件
2.3
使用Notepad++构建.NET应用程序
2.4
使用SharpDevelop构建.NET应用程序
2.5
使用Visual C#
Express构建.NET应用程序
2.6
使用Visual
Studio构建.NET应用程序
2.6.1
Visual Studio的独特功能
2.6.2
使用New
Project对话框指向.NET
Framework
2.6.3
解决方案资源管理器
2.6.4
Class View工具
2.6.5
Object Browser工具
2.6.6
集成对代码重构的支持
2.6.7
代码扩展和围绕技术
2.6.8
可视化Class
Designer
2.6.9
集成的.NET Framework 4.5
SDK文档系统
2.7
小结

性能指南

  • 使用 Any() 判断 IEnumerable 是否为空 ;
  • 仅对低密集型活动使用异步;
  • 对于 CPU密集型使用 Task.Run
  • 避免同时将 async/awaitTask.Wait 混合使用;
  • 避免 async/await 在单线程环境下出现死锁;

                        《精通c#(第6版)》【PDF】下载链接:

可维护性指南

  • 方法内部的代码段尽量不要超过 7 行;
  • 确保所有成员私有,类的类型默认为为 internal sealed
  • 避免双重条件;
  • 在其包含的命名空间内命名程序集;
  • 将源文件命名为它所包含的类型;
  • 将源文件的内容限制为一种类型;
  • 将不同的逻辑函数放到同一个部分类中;
  • 在使用一个类型时,使用 using
    关键字导入需要的命名空间,而不是类型的完整空间标识;
  • 不要使用魔法数;
  • 只有当类型显而易见时才使用 var 关键字;
  • 定义变量时尽可能地初始化;
  • 在相互独立的代码段中定义临时变量;
  • 若对象有集合需要初始化的话在进行对象初始化的同时进行集合初始化;
  • 不要显式进行 bool 值的比较;
  • 避免嵌套循环;
  • 在使用
    ifelsedowhileforforeachcase
    的同时使用 {}
  • switch case 代码段中添加 default 逻辑;
  • 在所有的 ifelse if 后再添加 else;
  • 避免使用多个返回值;
  • 考虑使用简单的条件语句代替 if else
  • 封装属性、方法或局部函数中的复杂表达式;
  • 再合适的情况下尝试重载方法;
  • 使用可选参数来代替重载;
  • 避免使用命名参数;
  • 避免定义超过3个参数的签名;
  • 避免函数签名为布尔类型;
  • 不要将参数作为临时变量使用;
  • 将模式作为操作;
  • 不要注释代码;

第6章继承和多态
6.1
继承的基本机制
6.1.1
指定既有类的父类
6.1.2
多个基类
6.1.3
sealed关键字
6.2
回顾Visual
Studio类关系图
6.3
OOP的第二个支柱:继承
6.3.1
使用base关键字控制基类的创建
6.3.2
家族的秘密:protected关键字
6.3.3
增加密封类
6.4
包含/委托编程
6.5
OOP的第三个支柱:C#的多态支持
6.5.1
virtual和override关键字
6.5.2
使用Visual Studio
IDE重写虚方法
6.5.3
密封虚成员
6.5.4
抽象类
6.5.5
构建多态接口
6.5.6
成员投影
6.6
基类/派生类的转换规则
6.6.1
C#的as关键字
6.6.2
C#的is关键字
6.7
超级父类:System.Object
6.7.1
重写System.Object.ToString
6.7.2
重写System.Object.Equals
6.7.3
重写System.Object.GetHashCode
6.7.4
测试修改后的Person类
6.7.5
System.Object的静态成员
6.8
小结

相关链接

  • Code Complete: A Praccal Handbook of Soware Construcon (Steve
    McConnel)
  • The Art of Agile Development (James
    Shore)
  • Applying Domain-Driven Design and Paerns: With Examples in C# and
    .NET (Jimmy
    Nilsson)
  • Jeremy D. Miller’s
    Blog
  • LINQ Framework Design
    Guidelines
  • Best Pracces for c#
    async/await

第12章 LINQ to Object
12.1
LINQ特有的编程结构
12.1.1
隐式类型本地变量
12.1.2
对象和集合初始化语法
12.1.3
Lambda表达式
12.1.4
扩展方法
12.1.5
匿名类型
12.2
LINQ的作用
12.2.1
LINQ表达式是强类型的
12.2.2
核心LINQ程序集
12.3
将LINQ查询应用于原始数组
12.3.1
再一次,不使用LINQ
12.3.2
反射LINQ结果集
12.3.3
LINQ和隐式类型本地变量
12.3.4
LINQ和扩展方法
12.3.5
延迟执行的作用
12.3.6
立即执行的作用
12.4
返回LINQ查询的结果
12.5
将LINQ查询应用到集合对象
12.5.1
访问包含的子对象
12.5.2
将LINQ查询应用于非泛型集合
12.5.3
使用OfType筛选数据
12.6
C# LINQ查询操作符
12.6.1
基本的选择语法
12.6.2
获取数据子集
12.6.3
投影新数据类型
12.6.4
使用Enumerable获取总数
12.6.5
反转结果集
12.6.6
对表达式进行排序
12.6.7
维恩图工具
12.6.8
移除重复
12.6.9
LINQ聚合操作
12.7
LINQ查询语句的内部表示
12.7.1
用查询操作符建立查询表达式(复习)
12.7.2
使用Enumerable类型和Lambda表达式来建立查询表达式
12.7.3
使用Enumerable类型和匿名方法来建立查询表达式
12.7.4
用Enumerable类型和原始委托建立查询表达式
12.8
小结

其他设计指南

  • 抛出异常而不是返回某种类型的状态值;
  • 提供完整而有意义的异常信息;
  • 抛出适当的最具体的异常;
  • 不要通过 try – catch 方式隐藏异常;
  • 正确处理异步代码中的异常;
  • 调用事件委托前先判断是否为空;

event EventHandler<string> Notify;
protected virtual void OnNotify(string args)
{
    Notify?.Invoke(this, args);
}
  • 使用受保护的虚方法来触发每个事件;
  • 考虑添加属性变化事件;
  • 当触发事件时要确保 sender != nulll;
  • 如果合适的话,请考虑使用泛型约束;

class SomeClass
{
}

/// <summary>
/// 不推荐
/// </summary>
class MyClass1
{
    void SomeMethod<T>(T t)
    {
        object temp = t;
        SomeClass obj = (SomeClass)temp;
    }
}

/// <summary>
/// 推荐
/// </summary>
class MyClass2
{
    void SomeMethod<T>(T t) where T :SomeClass
    {
        SomeClass obj = t;
    }
}
  • 在返回 LINQ 表达式之前计算它的结果;
  • 如果不是必须,不要使用 thisbase 关键字;

第7章结构化异常处理
7.1
错误、bug与异常
7.2
.NET异常处理的作用
7.2.1
.NET异常处理的四要素
7.2.2
System.Exception基类
7.3
最简单的例子
7.3.1
引发普通的异常
7.3.2
捕获异常
7.4
配置异常的状态
7.4.1
TargetSite属性
7.4.2
StackTrace属性
7.4.3
HelpLink属性
7.4.4
Data属性
7.5
系统级异常
7.6
应用程序级异常
7.6.1
构建自定义异常,第一部分
7.6.2
构建自定义异常,第二部分
7.6.3
构建自定义异常,第三部分
7.7
处理多个异常
7.7.1
通用的catch语句
7.7.2
再次引发异常
7.7.3
内部异常
7.7.4
finally块
7.8
谁在引发什么异常
7.9
未处理异常的后果
7.10
使用Visual
Studio调试未处理的异常
7.11
小结


第三部分 C#面向对象编程
第5章封装
5.1
C#类类型
5.2
构造函数
5.2.1
默认构造函数的作用
5.2.2
定义自定义的构造函数
5.2.3
再谈默认构造函数
5.3
this关键字的作用
5.3.1
使用this进行串联构造函数调用
5.3.2
观察构造函数流程
5.3.3
再谈可选参数
5.4
static关键字
5.4.1
定义静态数据
5.4.2
定义静态方法
5.4.3
定义静态构造函数
5.4.4
定义静态类
5.5
定义OOP的支柱
5.5.1
封装的作用
5.5.2
继承的作用
5.5.3
多态的作用
5.6
C#访问修饰符
5.6.1
默认的访问修饰符
5.6.2
访问修饰符和嵌套类型
5.7
第一个支柱:C#的封装服务
5.7.1
使用传统的访问方法和修改方法执行封装
5.7.2
使用.NET属性进行封装
5.7.3
使用类的属性
5.7.4
只读和只写属性
5.7.5
静态属性
5.8
自动属性
5.8.1
与自动属性交互
5.8.2
关于自动属性和默认值
5.9
对象初始化语法
5.9.1
使用初始化语法调用自定义构造函数
5.9.2
初始化内部类型
5.10
常量数据
5.10.1
只读字段
5.10.2
静态只读字段
5.11
分部类型
5.12
小结

命名指南

  • 不要在变量、参数和类型成员中包含数字;
  • 不要在字段添加前缀;
  • 不要使用缩写;
  • 成员、参数和变量定义要根据它们代表的意义;
  • 使用名词、名词短语或者形容词来定义类型;
  • 使用描述性名称命名泛型参数;
  • 在类成员中不要重复定义和类相同的名称;
  • 成员定义可参考 .Net Framework 的定义方式;
  • 避免使用可能被误解的段名称或字段;
  • 正确定义属性;
  • 在命名方法或局部函数时使用谓词或谓词对象;
  • 使用名称、层、谓词和功能申明命名空间;
  • 使用动词或动词前缀来定义事件;
  • 使用 ingend 后缀来表达事件预处理和发送事件;
  • 使用 on 前缀来定义事件处理程序;
  • 使用 Async 或者 TaskAsync 来标识异步方法;

图灵程序设计丛书:精通C#(第6版)是C#领域久负盛名的经典著作,深入全面地讲解了C#编程语言和。NET平台的核心内容,并结合大量示例剖析相关概念。全书分为八部分:C#和。NET平台、C#核心编程结构、C#面向对象编程、高级C#编程结构、用。NET程序集编程、。NET基础类库、WPF和ASP。NETWebForms。第6版是对第5版的进一步更新和完善,内容涵盖了最先进的。NET编程技术和技巧,并准确呈现出C#编程语言的最新变化和。NET4。5Framework的新特性。

目录

第11章 高级C#语言特性
11.1
索引器方法
11.1.1
使用字符串值索引对象
11.1.2
重载索引器方法
11.1.3
多维的索引器
11.1.4
在接口类型上定义索引器
11.2
操作符重载
11.2.1
重载二元操作符
11.2.2
+=与-=操作符
11.2.3
重载一元操作符
11.2.4
重载相等操作符
11.2.5
重载比较操作符
11.2.6
操作符重载的最后思考
11.3
自定义类型转换
11.3.1
回顾:数值转换
11.3.2
回顾:相关的类类型间的转换
11.3.3
创建自定义转换例程
11.3.4
Square类型的其他显式转换
11.3.5
定义隐式转换例程
11.4
扩展方法
11.4.1
定义扩展方法
11.4.2
在实例层次上调用扩展方法
11.4.3
导入扩展方法
11.4.4
扩展方法的智能感知
11.4.5
扩展实现了指定接口的类型
11.5
匿名类型
11.5.1
定义匿名类型
11.5.2
匿名类型的内部表示方式
11.5.3
方法ToString和GetHashCode的实现
11.5.4
匿名类型的相等语义
11.5.5
包含匿名类型的匿名类型
11.6
指针类型
11.6.1
unsafe关键字
11.6.2
*和 操作符
11.6.3
不安全(与安全)交换功能
11.6.4
通过指针访问字段
11.6.5
stackalloc关键字
11.6.6
使用fixed关键字固定类型
11.6.7
sizeof关键字
11.7
小结

发表评论

电子邮件地址不会被公开。 必填项已用*标注