琐记之C#编程风格

     一般原则

1、保持原有风格

        修改别人编写的软件时，应遵循原始代码的风格。修改时不要引入新风格，也不要仅为了吻合新风格而重写旧软件。在一个源代码文件中存在多种风格会使代码更难读懂。为修改风格而重写代码将产生本可避免的缺陷，增加软件成本。（写机器懂的代码容易，写人懂的代码难。）

2、坚持最小惊奇原则

       最小惊奇原则建议你避免做出可能让其他软件开发人员吃惊的事情。这意味着，软件所展示的互动及行为方式必须可预料并保持一致。如果不是这样，文档就必须清晰地指出所有非通常的用法或行为。

       为了降低他人在使用你的软件时遭遇惊奇的可能性，你应当在软件的设计、实现、打包和文档中强调以下原则：

       简单性：用简单的类和简单的方法满足用户期望。

清晰性：确保每个类、接口、方法、变量和对象都有清晰的目的。阐明何时、何处、如何使用它们。

完整性：提供任一可能的用户期望找到和使用的最小功能。创建完整文档，描述所有特性和功能。

一致性：相似褓的外观和行为应该相同，不同褓的外观和行为应该不同。应该尽可能制定并遵守相关标准。

健壮性：对软件中可能出现的错误和异常做出预测，并将解决方法记入文档。不要隐藏错误，也不要等用户去发现错误。

3、第一次就做对

        对所有的代码实施这条规则，不仅限于正式产品的代码。原型或试验性代码多半会用到最终产品中，所以你该洞悉先机。即便代码永远不会采用到正式产品中，别人也有可能读到它。任何阅读你的代码的人，都会从你的专业性和贯彻这些规则的先见之明中获益匪浅。

4、记录所有非规范行为

没有十全十美、普适一切的标准。有时你会有偏离某条既定标准的需要。无论如何也要努力保持清晰和一致。

在决定忽略某条规则之前，你应该先确信自己了解该条规则存在之理由，以及不采用该规则会引起的后果。如果你决定要违反某条规则，记录下这么做的原因。这是第一守则。

5、考虑采用代码检查工具强制遵循编码标准

可采用源代码分析工具检查代码是否符合编码标准和最佳实践。例如，FxCop是一种流行的.NET代码分析工具，它利用反射技术、MSIL解析和调用图分析来检查代码是否符合.NET框架设计的指导原则。FxCop可扩展，所以能加入你所在组织的特殊编码标准。