如何编写出好的代码

一、命名约定
使程序易于理解的一个重要方面是给对象选择命名的方式，包括变量名、方法名、类名、枚举名和命名空间的名称。
名称的约定包括以下几个方面：
(1) 名称的大小写
在许多情况下，名称都应使用Pascal大小写命名形式。 Pascal 大小写形式是指名称中单词的第一个字母大写，如EmployeeSalary、ConfirmationDialog。注意，命名空间、类、以及基类中的成员等的名称都应遵循该规则，最好不要使用带有下划线字符的单词，即名称不应是employee_salary。其他语言中常量的名称常常全部都是大写，但在C#中最好不要这样，因为这种名称很难阅读，而应全部使用Pascal 大小写形式的命名约定。

我们还推荐使用另一种大小写模式：camel大小写形式。这种形式类似于Pascal 大小写形式，但名称中第一个单词的第一个字母不是大写：employeeSalary、confirmationDialog。
有三种情况可以使用camel大小写形式。
1、类型中所有私有成员字段的名称都应是camel大小写形式：
2、传递给方法的所有参数都应是camel大小写形式：
3、camel大小写形式也可以用于区分同名的两个对象-- 比较常见的情况是属性封装一个字段

(2) 名称的风格
名称的风格应保持一致。例如，如果类中的一个方法叫ShowConfirmationDialog()，另一个方法就不能叫ShowDialogWarning()或WarningDialogShow()，而应是ShowWarningDialog()。

(3) 命名空间的名称
命名空间的名称非常重要，一定要仔细设计，以避免一个命名空间中对象的名称与其他对象同名。记住，命名空间的名称是.NET区分共享程序集中对象名的唯一方式。如果软件包的命名空间使用的名称与另一个软件包相同，而这两个软件包都安装在一台计算机上，就会出问题。因此，最好用自己的公司名创建顶级的命名空间，再嵌套技术范围较窄、用户所在小组或部门、或类所在软件包的命名空间。

(4) 名称和关键字
名称不应与任何关键字冲突，这是非常重要的。


二、 属性和方法的使用
类中出现混乱的一个方面是一个数是用属性还是方法来表示。这没有硬性规定，但一般情况下，如果该对象的外观和操作都像一个变量，就应使用属性来表示它，即：
(1)客户机代码应能读取它的值，最好不要使用只写属性，例如，应使用SetPassword()方法，而不是Password只写属性。
(2)读取该值不应花太长的时间。实际上，如果它是一个属性，通常表示读取过程花的时间相对较短。
(3)读取该值不应有任何不希望的负面效应。设置属性的值，不应有与该属性不直接相关的负面效应。设置对话框的宽度会改变该对话框在屏幕上的外观，这是可以的，因为它与属性是相关的。
(4)应可以用任何顺序设置属性。在设置属性时，最好不要因为还没有设置另一个相关的属性而抛出一个异常。例如，如果为了使用访问数据库的类，需要设置ConnectionString、UserName和Password，应确保已经执行了该类，这样用户才能按照任何顺序设置它们。
(5)顺序读取属性也应有相同的效果。如果属性的值可能会出现预料不到的改变，就应把它编写为一个方法。在监视汽车运动的类中，把speed编写为属性就不是一种好的方式，而应使用GetSpeed()，另一方面，应把Weight 和EngineSize编写为属性，因为对于给定的对象，它们是不会改变的。

三、字段的用法
字段的用法非常简单。字段应总是私有的，但在某些情况下也可以把常量或只读字段设置为公有，原因是如果把字段设置为公有，就可以在以后扩展或修改类。

遵循上面的规则就可以编写出好的代码，而且这些规则应与面向对编程的风格一起使用。