随笔分类 - 编写高质量代码改善C#程序的157个建议
摘要：建议137：委托和事件类型应添加上级后缀 委托类型本身是一个类，考虑让派生类的名字以基类名字作为后缀。事件类型是一类特殊的委托，所以事件类型也遵循本建议。 委托和事件的正确的命名方式有： 若果用传统方式，我们可能看不出来这些类型是有基类的，但是委托和事件的关键字delegate和event已经指明了
阅读全文
摘要：建议136：优先使用后缀表示已有类型的新版本 加后缀在某些情况下是很奇怪的形式，我们都不愿意看到OrderProcessor2这样的类型。但是，有的时候仍旧有必要这样做。最典型的是FCL中关于数字证书操作的X509Certificate和X509Certificate2这两个类型。 X509Cert
阅读全文
摘要：建议135： 考虑使用肯定性的短语命名布尔属性 布尔值无非就是True和False，所以应该用肯定性的短语来表示它，例如，以Is、Can、Has作为前缀。 布尔属性正确命名的一个示例如下： 反面教材： 肯定性形容词或者短语虽然表达了一个肯定的含义，但是这些单词或者短语现在都被用于命名事件或者委托，所
阅读全文
摘要：建议134：有条件地使用前缀 在.NET的设计规范中，不建议使用前缀。但是，即便是微软自己依然广泛的使用这前缀。 最典型的前缀是m_，这种命名一方面是考虑到历史沿革中的习惯问题，另一方面也许我们确实有必要这么做。 在一个不是很庞大的类型中，我们确实不应该使用任何前缀。各类设计规范也总建议我们保持一个
阅读全文
摘要：建议133：用camelCasing命名私有字段和局部变量 私有变量和局部变量只对本类型负责，它们在命名方式也采用和开放的属性及字段不同的方法。camelCasing很适合这类命名。 camelCasing和PascalCasing的区别是它的首字母是小写的。之所以要采用这两种不同的命名规则，是为了
阅读全文
摘要：建议132：考虑用类名作为属性名 一般来说，若果属性对应一个类型，应该直接用类型名命名属性名。如下： 没有必要为属性名指定另外的名字，如： 当然，除非我们的类型当中有多个Company类型的属性，这样就必须为我们的属性重构成不同的命名，如： 转自：《编写高质量代码改善C#程序的157个建议》陆敏技
阅读全文
摘要：建议131：用PascalCasing命名公开元素 开放给调用者的属性、字段和方法都应该采用PascalCasing命名方法，比如： 这样，调用者在调用的代码看起来如下： person.Name 如果我们不注意这样的命名规则，让调用方的代码看起像这样： person.name 我们首先会怀疑name
阅读全文
摘要：建议130：以复数命名枚举类型，以单数命名枚举元素 枚举类型应该具有负数形式，它表达的是将一组相关元素组合起来的语义。比如： 在这里，Week对于星期几来说，具备复数含义。如果我们将Week修改为Day，那么调用的代码会变成如下形式： Day.Monday 它不会比下面的代码更简洁了： Week.M
阅读全文
摘要：建议129：泛型类型参数要以T作为前缀 作为一种约定，泛型类型的参数要以T作为前缀。如委托声明： Action<T1,T2> 其中，泛型类型参数名不应该处理成： Action<Arg1,Arg2> 当然，这仅仅是一种习惯，若果使用第二种命名方式，编译器并不会报错，但是作为调用者，也许不能意识到这里是
阅读全文
摘要：建议128：考虑让派生类的名字以基类名字作为后缀 派生类的名字可以考虑以基类名字作为后缀。这带来的好处是，从类型的名字上我们就知道它包含在哪一个继承体系中。 Exception及其子类就是这样一个典型的例子。所有的异常都应该继承自System.Exception，而所有的异常都应该命名为Custom
阅读全文
摘要：建议127：用形容词组给接口命名 接口规范的是“Can do”，也就是说，它规范的是类型可以具有哪些行为。所以，接口的命名应该是一个形容词，如： IDisposable表示可以被释放 IEnumerable表示类型含有Items，可以被迭代。 正是因为接口表示的是类型的行为，所以从语义上可以让类型继
阅读全文
摘要：建议126：用名词和名词组给类型命名 类型对应着现实世界中的实际对象。对象在语言中意味着它是一个名词。所以，类型也应该以名词或名词词组去命名。 类型定义了属性和行为。虽然它包含行为，但不是行为本身。所以，下面的一些命名对于类型来说是好的命名： OrderProcessor ScoreManager
阅读全文
摘要：建议125：避免用FCL的类型名称命名自己的类型 试想过自己写一个Socket类型吗？如果没有，我们来尝试一下： 把以上代码同某些其他工具类封装到某个dll里，让其他人调用。调用者代码如下： 接着编译、运行程序，我们会发现编译没有报错，程序运行也很好。我相信，看到这段代码的人员，可能都会认为我们是在
阅读全文
摘要：建议124：考虑在命名空间中使用复数 如果有一组功能相近的类型被分到了同一个命名空间想，可以考虑为命名空间使用复数。 最典型的例子有，在FCL中，我们需要把所有的非泛型集合类集中在一起存放，所以就有了System.Collections命名空间。这样的命名规范，好处是即便没有使用过集合类的人，看到这
阅读全文
摘要：建议123：程序集不必与命名空间同名 程序集一般会和命名空间同名，但这并不是必须的。事实上，不同名的命名空间和程序集是很常见的。 程序集表示的是一种物理上的分组，而命名空间是逻辑上的分组，两者没有必然联系。 当然，如果项目最终会被编译为dll，则我们更建议程序集和命名空间命名保持一致，这看上去更符合
阅读全文
摘要：建议122：以<Company>.<Component>为命名空间命名 建议以<Company>.<Component>为程序集命名，比如Microsoft.Windows.Design。这有助于唯一地标识我们的命名空间。 另外一种有效且肯定是唯一的表示命名空间的方式是使用域名。假设我们的域名是ww
阅读全文
摘要：建议121：为应用程序设定运行权限 在某些情况下，可能存在这样的需求：只有系统管理员才能访问某应用程序的若干功能。这个时候，可以结合.NET中提供的代码访问安全性（Code Access Security）和基于角色（Role-Based Security）的安全性去实现。 如果要通过一下的代码正常
阅读全文
摘要：建议119：不要使用自己的加密算法 很多人认为自己写的加密算法才是安全的，因为该算法只有“自己知道”。很遗憾，这是大错特错。 首先，我们不是秘密学专家，如果我们随随便便写个算法就称得上是加密算法的话，那么世界上就不会存在“密码学”这个专门的学科了。 其次，应当记住的是：让数据安全的不是加密算法本身，
阅读全文
摘要：建议118：使用SecureString保存密钥等机密字符串 托管代码中的字符串是一类特殊的对象，它们不可用被改变。每次使用System.String类张的方法之一时，或者使用此类型进行运算时（如赋值、拼接等），都要在内存中创建新的字符串对象，也就是为该新对象分配新的空间。这就带来了两个问题： 针对
阅读全文
摘要：建议117：使用SSL确保通信中的数据安全 SSL（Secure Socket Layer）最初是由NetScape公司设计的，用于Web安全的网络协议。目前它已经广泛应用到各类网络传输通信中了。SSL利用数字证书技术（非对称加密），保证了通信过程中的唯一性、不可篡改性、不可抵赖性。SSL通道原理图
阅读全文