读 《CSharp Coding Guidelines》有感澳门新萄京:

目录

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

  • 基本原则
  • 类设计指南
  • 属性成员设计指南
  • 其他设计指南
  • 可维护性指南
  • 命名指南
  • 性能指南
  • 框架指南
  • 文档指南
  • 布局指南
  • 相关链接

《图灵程序设计丛书:精通C#(第6版)》由微软C#MVPAndrewTroelsen编写,第6版专门针对C#5。0和。NET4。5进行了细致入微的修订,是各层次。NET开发人员的必读之作。


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

C# 编程指南

第一部分 C#与.NET平台
第1章
.NET之道
1.1
初识.NET平台
1.2
.NET平台构造块(CLR、CTS和CLS)简介
1.2.1
基础类库的作用
11.2.3
托管代码与非托管代码
1.3
其他支持.NET的编程语言
1.4
.NET程序集概览
1.4.1
CIL的作用
1.4.2
.NET类型元数据的作用
1.4.3
程序集清单的作用
1.5
CTS
1.5.1
CTS类类型
1.5.2
CTS接口类型
1.5.3
CTS结构类型
1.5.4
CTS枚举类型
1.5.5
CTS委托类型
1.5.6
CTS类型成员
1.5.7
内建的CTS数据类型
1.6
CLS
1.7
CLR
1.8
程序集/命名空间/类型的区别
1.8.1
Microsoft根命名空间的作用
1.8.2
以编程方式访问命名空间
1.8.3
引用外部程序集
1.9
使用ildasm.exe探索程序集
1.9.1
查看CIL代码
1.9.2
查看类型元数据
1.9.3
查看程序集元数据(即清单)
1.10
.NET的平台无关性
1.11
Windows 8应用程序简介
1.11.1
构建Windows
8应用程序
1.11.2
.NET在Windows
8中的作用
1.12
小结

前不久在 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
小结

基本原则

  • Astonishment
    原则:你的代码应该尽量做到让每一个人都能理解。任何人都有写出让机器认识的代码,但是并不是每个人都能写出让人认识的代码;
  • Kiss 原则:类似 Python 之禅 里面说的那样,简单胜于复杂;
  • YAGNI
    原则:代码尽量能做到可扩展,但请不要过度重构,因为你不能预知未来;
  • DRY 原则:不要重复造轮子,除非你有时间或者你造的轮子会比别人的优秀;
  • 面向对象编程原则:继承、封装、多态、抽象;

第二部分 C#核心编程结构
第3章
C#核心编程结构
3.1
一个简单的C#程序
3.1.1
Main方法的其他形式
3.1.2
指定应用程序错误代码
3.1.3
处理命令行参数
3.1.4
使用Visual
Studio指定命令行参数
3.2
有趣的题外话:System.Environment类的其他成员
3.3
System.Console类
3.3.1
使用Console类进行基本的输入和输出
3.3.2
格式化控制台输出
3.3.3
格式化数值数据
3.3.4
在控制台应用程序外格式化数值数据
3.4
系统数据类型和相应的C#关键字
3.4.1
变量声明和初始化
3.4.2
内建数据类型与new操作符
3.4.3
数据类型类的层次结构
3.4.4
数值数据类型的成员
3.4.5
System.Boolean的成员
3.4.6
System.Char的成员
3.4.7
从字符串数据中解析数值
3.4.8
System.DateTime和System.TimeSpan
3.4.9
System.Numerics.dll程序集
3.5
使用字符串数据
3.5.1
基本的字符串操作
3.5.2
字符串拼接
3.5.3
转义字符
3.5.4
定义逐字字符串
3.5.5
字符串和相等性
3.5.6
字符串是不可变的
3.5.7
System.Text.StringBuilder类型
3.6
窄化和宽化数据类型转换
3.6.1
checked关键字
3.6.2
设定项目级别的溢出检测
3.6.3
unchecked关键字
3.7
隐式类型本地变量
3.7.1
隐式类型变量的限制
3.7.2
隐式类型数据是强类型数据
3.7.3
隐式类型本地变量的用途
3.8
C#迭代结构
3.8.1
for循环
3.8.2
foreach循环
3.8.3
while和do/while循环结构
3.9
条件结构和关系/相等操作符
3.9.1
if/else语句
3.9.2
关系/相等操作符
3.9.3
逻辑操作符
3.9.4
switch语句
3.10
小结

类设计指南

  • 一个类/接口应该只有一个用途,要符 合单一职责 原则;
  • 只创建返回有用对象的构造函数,当构造函数的参数超过 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
关键字来重写基类方法。在项目复杂的情况下,使用这种方式将导致我们不能准确预测是子类调用还是父类调用,使代码复杂度提升。

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

第4章 C#核心编程结构
4.1
方法和参数修饰符
4.1.1
默认的参数传递行为
4.1.2
out修饰符
4.1.3
ref修饰符
4.1.4
params修饰符
4.1.5
定义可选参数
4.1.6
使用命名参数调用方法
4.1.7
成员重载
4.2
C#数组
4.2.1
C#数组初始化语法
4.2.2
隐式类型本地数组
澳门新萄京 ,4.2.3
定义object数组
4.2.4
使用多维数组
4.2.5
数组作为参数(和返回值)
4.2.6
System.Array基类
4.3
枚举类型
4.3.1
控制枚举的底层存储
4.3.2
声明枚举变量
4.3.3
System.Enum类型
4.3.4
动态获取枚举的名称/值对
4.4
结构类型
4.5
值类型和引用类型
4.5.1
值类型、引用类型和赋值操作符
4.5.2
包含引用类型的值类型
4.5.3
按值传递引用类型
4.5.4
按引用传递引用类型
4.5.5
值类型和引用类型:最后的细节
4.6
C#可空类型
4.6.1
使用可空类型
4.6.2
??操作符
4.7
小结

属性成员设计指南

  • 允许按任意顺序设置属性;
  • 使用方法而不是属性;
  • 不要使用相互排斥的属性;
  • 属性、方法或者本地方法只应该做一件事情;
  • 不要通过静态成员公开有状态的对象;
  • 用 IEnumerable 或者 ICollection 来代替具体的集合对象作为返回值;
  • 如果属性、参数和返回值是字符串或者集合类型的话,则永远不应该为空;
  • 尽可能地定义具体的参数;
  • 考虑使用特定域的值类型而不是基元;

第三部分 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
小结

其他设计指南

  • 抛出异常而不是返回某种类型的状态值;
  • 提供完整而有意义的异常信息;
  • 抛出适当的最具体的异常;
  • 不要通过 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 关键字;

第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
小结

可维护性指南

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

第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
小结

发表评论

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