C#编码好习惯
发表日期：2006-12-21
-
1. 避免将多个类放在一个文件里面。
2. 一个文件应该只有一个命名空间，避免将多个命名空间放在同一个文件里面。
3. 一个文件最好不要超过500行的代码（不包括机器产生的代码）。
4. 一个方法的代码长度最好不要超过25行。
5. 避免方法中有超过5个参数的情况。使用结构来传递多个参数。
6. 每行代码不要超过80个字符。
7. 不要手工的修改机器产生的代码。
a) 如果需要编辑机器产生的代码，编辑格式和风格要符合该编码标准。
b) Use partial classes whenever possible to factor out the maintained portions.
8. 避免利用注释解释显而易见的代码。
a) 代码应该可以自解释。好的代码由可读的变量和方法命名因此不需要注释。
9. Document only Operational assumptions, algorithm insights and so on.
10. 避免使用方法级的文档。
a) 使用扩展的API文档说明之。
b) 只有在该方法需要被其他的开发者使用的时候才使用方法级的注释。（在C#中就是///）
11. 不要硬编码数字的值，总是使用构造函数设定其值。
12. 只有是自然结构才能直接使用const，比如一个星期的天数。
13. 避免在只读的变量上使用const。如果想实现只读，可以直接使用readonly。
public class MyClass
{
public readonly int Number;
public MyClass(int someValue)
{
Number = someValue;
}
public const int DaysInWeek = 7;
}
14. 每个假设必须使用Assert检查
a) 平均每15行要有一次检查(Assert)
using System.Diagnostics;
object GetObject()
{…}
object obj = GetObject();
Debug.Assert(obj != null);
15. 代码的每一行都应该通过白盒方式的测试。
16. 只抛出已经显示处理的异常。
17. 在捕获(catch)语句的抛出异常子句中(throw)，总是抛出原始异常维护原始错误的堆栈分配。
catch(Exception exception)
{
MessageBox.Show(exception.Message);
throw ; //和throw exception一样。
}
18. 避免方法的返回值是错误代码。
19. 尽量避免定义自定义异常类。
20. 当需要定义自定义的异常时：
a) 自定义异常要继承于applicationException。
b) 提供自定义的序列化功能。
21. 避免在单个程序集里使用多个Main方法。
22. 只对外公布必要的操作，其他的则为internal。
23. Avoid friend assemblies, as it increases inter-assembly coupling.
24. Avoid code that relies on an assembly running from a particular location.
25. 使应用程序集尽量为最小化代码(EXE客户程序)。使用类库来替换包含的商务逻辑。
26. 避免给枚举变量提供显式的值。
//正确方法
public enum Color
{
Red,Green,Blue
}
//避免
public enum Color
{
Red = 1,Green = 2,Blue = 3
}
27. 避免指定特殊类型的枚举变量。
//避免
public enum Color : long
{
Red,Green,Blue
}
28. 即使if语句只有一句，也要将if语句的内容用大括号扩起来。
29. 避免使用trinary条件操作符。
30. 避免在条件语句中调用返回bool值的函数。可以使用局部变量并检查这些局部变量。
bool IsEverythingOK()
{…}
//避免
if (IsEverythingOK ())
{…}
//替换方案
bool ok = IsEverythingOK();
if (ok)
{…}
31. 总是使用基于0开始的数组。
32. 在循环中总是显式的初始化引用类型的数组。
public class MyClass
{}
MyClass[] array = new MyClass[100];
for(int index = 0; index < array.Length; index++)
{
array[index] = new MyClass();
}
33. 不要提供public 和 PRotected的成员变量，使用属性代替他们。
34. 避免在继承中使用new而使用override替换。
35. 在不是sealed的类中总是将public 和 protected的方法标记成virtual的。
36. 除非使用interop(COM+ 或其他的dll)代码否则不要使用不安全的代码(unsafe code)。
37. 避免显示的转换，使用as操作符进行兼容类型的转换。
Dog dog = new GermanShepherd();
GermanShepherd shepherd = dog as GermanShepherd;
if (shepherd != null )
{…}
38. 当类成员包括委托的时候
a) Copy a delegate to a local variable before publishing to avoid concurrency race
condition.
b) 在调用委托之前一定要检查它是否为null
public class MySource
{
public event EventHandler MyEvent;
public void FireEvent()
{
EventHandler temp = MyEvent;
if(temp != null )
{
temp(this,EventArgs.Empty);
}
}
}
39. 不要提供公共的事件成员变量，使用事件访问器替换这些变量。
public class MySource
{
MyDelegate m_SomeEvent ;
public event MyDelegate SomeEvent
{
add
{
m_SomeEvent += value;
}
remove
{
m_SomeEvent -= value;
}
}
}
40. 使用一个事件帮助类来公布事件的定义。
41. 总是使用接口。
42. 类和接口中的方法和属性至少为2:1的比例。
43. 避免一个接口中只有一个成员。
44. 尽量使每个接口中包含3－5个成员。
45. 接口中的成员不应该超过20个。
a) 实际情况可能限制为12个
46. 避免接口成员中包含事件。
47. 避免使用抽象方法而使用接口替换。
48. 在类层次中显示接口。
49. 推荐使用显式的接口实现。
50. 从不假设一个类型兼容一个接口。Defensively query for that interface.
SomeType obj1;
IMyInterface obj2;
/* 假设已有代码初始化过obj1，接下来 */
obj2 = obj1 as IMyInterface;
if (obj2 != null)
{
obj2.Method1();
}
else
{
//处理错误
}
51. 表现给最终用户的字符串不要使用硬编码而要使用资源文件替换之。
52. 不要硬编码可能更改的基于配置的字符串，比如连接字符串。
53. 当需要构建长的字符串的时候，使用StringBuilder不要使用string
54. 避免在结构里面提供方法。
a) 建议使用参数化构造函数
b) 可以重裁操作符
55. 总是要给静态变量提供静态构造函数。
56. 能使用早期绑定就不要使用后期绑定。
57. 使用应用程序的日志和跟踪。
58. 除非在不完全的switch语句中否则不要使用goto语句。
59. 在switch语句中总是要有default子句来显示信息(Assert)。
int number = SomeMethod();
switch(number)
{
case 1:
Trace.WriteLine("Case 1:");
break;
case 2:
Trace.WriteLine("Case 2:");
break;
default :
Debug.Assert(false);
break;
}
60. 除非在构造函数中调用其他构造函数否则不要使用this指针。
// 正确使用this的例子
public class MyClass
{
public MyClass(string message )
{}
public MyClass() : this("hello")
{}
}
61. 除非你想重写子类中存在名称冲突的成员或者调用基类的构造函数否则不要使用base来访问基类的成员。
// 正确使用base的例子
public class Dog
{
public Dog(string name)
{}
virtual public void Bark( int howLong)
{}
}
public class GermanShepherd : Dog
{
public GermanShe pherd(string name): base (name)
{}
override public void Bark(int howLong)
{
base .Bark(howLong);
}
}
62. 基于模板的时候要实现Dispose()和Finalize()两个方法。
63. 通常情况下避免有从System.Object转换来和由System.Object转换去的代码，而使用强制转换或者as操作符替换。
class SomeClass
{}
//避免：
class MyClass
{
void SomeMethod(T t)
{
object temp = t;
SomeClass obj = (SomeClass)temp;
}
}
// 正确：
class MyClass where T : SomeClass
{
void SomeMethod(T t)
{
SomeClass obj = t;
}
}
64. 在一般情况下不要定影有限制符的接口。接口的限制级别通常可以用强类型来替换之。
public class Customer
{…}
//避免：
public interface IList where T : Customer
{…}
//正确：
public interface ICustomerList : IList
{…}
65. 不确定在接口内的具体方法的限制条件。
66. 总是选择使用C#内置（一般的generics）的数据结构。
-
本文来自: 动态网站制作() 详细出处参考：
写出优雅简明代码的论题集 -- Csharp(C#)篇[1]
发表日期：2011-5-14
-
最近和一些朋友讨论如何写出优雅的代码，我们都很喜欢C#，所以以C#为例。主要一共有三位程序员在一起讨论，为简单起见我用ABC代表我们三个人。
有时候我们会针对一些代码进行讨论，有时候我们会提出一些观点，有时候我们会一起学习网上一些现有的博客，为了便于大家引用，我给每一个论题都编上号。
在很多情况下，我们的意见统一，那么我会给大家呈现我们的结论；但是有些情况我们有分歧。
你可以加入我们的讨论，我非常也希望能够获知你的意见，让我们一起茁壮成长！
好吧，让我们今天就开始。
论题一：函数越小越好!
相信绝大部分程序员会认同这一点，维护一个超过100行的函数会让人抓狂。
我记得我以前修改过一个用cobol写的程序，一个文件超过10万行，我为了进行一个极其小的修改花了3天的时间，而且最后自己也不知道会不会造成什么严重的后果。-- 这已经过去8年了，希望那段代码运行良好。
到底理想状态下，我们的函数应该不大于多少行？我们三个人的答案是：
A： 10 行
B： 15 行
C： 20 行
论题二：用 Linq 简化代码
Linq有时可以帮助我们写出一些非常“人性”的语句。
下面的这个函数是用于在数据库中插入新的评论：
public static void Create(IEnumerable Comments, SqlConnection cn)
{
// validate params
if (null == cn) throw new ArgumentNullException("cn");
if (cn.State != ConnectionState.Open) throw new ArgumentException("Invalid parameter: connection is not open.", "cn");
if (null == Comments) throw new ArgumentNullException("Comments");
foreach (CommentData data in Comments)
{
if (data.CommentId.HasValue)
throw new ArgumentNullException("Create is only for saving new data. Call save for existing data.", "data");
}
....
其中foreach这一部分可以简化为
if (Comments.Any(data => data.CommentId.HasValue))
{
throw new ArgumentNullException("Create is only for saving new data. Call save for existing data.", "data");
}
在这一点上，我们存在分歧，A认为没有必要进行简化，因为原来的已经很明确了；但B认为简化后的代码可读性更强，看上去更加直接。
论题三：集合初始值
希望每个人都已经知道C#的这个用法了，直接上一些代码：
3.1
原始代码：
List idsToFind = new List();
idsToFind.Add(1);
idsToFind.Add(2);
修改后：
List idsToFind = new List {1, 2};
3.2
原始代码：
var startingPoint = new Point();
startingPoint.X = 5;
startingPoint.Y = 13;
修改后： var startingPoint = new Point() { X = 5, Y = 13 };
论题四：运用 ？：和？？
据说，有些公司会拿这个来测试入门的程序员：
4.1
原始代码：
if (c != null)
System.Console.WriteLine(c.Name);
else
System.Console.WriteLine("List element has null value.");
修改后：
System.Console.WriteLine(c != null ? c.Name : "List element has null value.");
4.2
原始代码：
string name = value;
if (value == null)
{
name = string.Empty;
}
修改后： string name = (value != null) ? value : string.Empty;
还可以更简单，变成： string name = value ?? string.Empty;
论题五： 运用AS
原始代码：
if (employee is SalariedEmployee)
{
var salEmp = (SalariedEmployee)employee;
pay = salEmp.WeeklySalary;
// ...
}
修改后：
var salEmployee = employee as SalariedEmployee;
if (salEmployee != null)
{
pay = salEmployee.WeeklySalary;
// ...
}
论题六： 运用 using
using首次出现是在visual studio 2005 中，在这以前，很多程序员晕倒在了释放资源的逻辑中。使用using语句实际上生成的IL代码中是一个try, finally代码块，在finally代码块里释放资源。
原始代码： public IEnumerable GetOrders()
{
var orders = new List();
var con = new SqlConnection("some connection string");
var cmd = new SqlCommand("select * from orders", con);
var rs = cmd.ExecuteReader();
while (rs.Read())
{
// ...
}
rs.Dispose();
cmd.Dispose();
con.Dispose();
return orders;
}
这是一段非常丑陋的代码，我们完全迷失在dispose群中，什么时候要调用哪个dispose啊？ 天哪？ 如果我们用 finally， 可以将代码写为：
public IEnumerable GetOrders()
{
SqlConnection con = null;
SqlCommand cmd = null;
SqlDataReader rs = null;
var orders = new List();
try
{
con = new SqlConnection("some connection string");
cmd = new SqlCommand("select * from orders", con);
rs = cmd.ExecuteReader();
while (rs.Read())
{
// ...
}
}
finally
{
rs.Dispose();
cmd.Dispose();
con.Dispose();
}
return orders;
}
看看using到底给我们带来了什么：
public IEnumerable GetOrders()
{
var orders = new List();
using (var con = new SqlConnection("some connection string"))
{
using (var cmd = new SqlCommand("select * from orders", con))
{
using (var rs = cmd.ExecuteReader())
{
while (rs.Read())
{
// ...
}
}
}
}
return orders;
} 好多了，对吗？ 完全不用再用那一堆的try/finally 代码了，也不用使用一堆的null，为了使代码更轻巧，让我们再做小小修改：
public IEnumerable GetOrders()
{
var orders = new List();
using (var con = new SqlConnection("some connection string"))
using (var cmd = new SqlCommand("select * from orders", con))
using (var rs = cmd.ExecuteReader())
{
while (rs.Read())
{
// ...
}
}
return orders;
}
谢谢大家对本系列第一篇写出优雅简明代码的论题集 -- Csharp(C#)篇[1]的回复和讨论，我相信针锋相对的辩论不仅有助于发现答案，更让我们了解问题后面的实质。
对程序员而言，我们的代码需要：
1. 在预算内实现需求，让用户可以使用 -- 让自己或者公司可以赚到钱
2. 方便自己修改及日后维护
3. 方便别人修改及日后维护
4. 便于重复使用，为以后的开发节省时间
5. 让系统高效的运作
从美国商学院毕业的学生们掌握了很多相似的思维模式，这不仅有利于他们解决问题，更重要的是方便他们彼此之间沟通。-- 换句话说，他们毕业后都安装上了相同的协议和一些可通用的接口，这样有一个基础平台可以让他们协同工作。
论题七：命名规范
也许有人认为没有必要再提这个问题，但在日常编码生活中，这的确是一个很重要的话题。
7.1 类名、方法、常数使用Pascal casing
public class MyClass
{
const int DefaultNumber = 100;
public void MyMethod()
{ }
}
7.2 局部变量，参数用camel casing
partial void OnContactIdChanging(int value)
{
int number;
}
7.3 interface 名字以I 开头
7.4 尽量不用单个字符命名变量，象 i 或者 t 。使用 index 或者 temp 之类代替。
7.5 将所有来自framework 的 namespace 放在前面，而后再放第三方或自定义的:
using System;
using System.Linq;
using System.Data.Linq;
using System.Collections.Generic;
using System.Text;
using System.ComponentModel.DataAnnotations;
using CodeSmith.Data.Attributes;
using CodeSmith.Data.Rules;
论题八: 一个方法的参数不能超过5个，当多于5个时，应进行函数的拆分或者参数的封装。-- 嚯嚯就像论题一样的规定
一些说明：不是为了给自己一个紧箍咒，而是在日常编程中，我们发现如果你写的方法不满足这样一个条件，一年后，就算是你自己也不太想去维护和修改，如果换成是其他程序员会对此更加的头痛，对吗？
论题九： 不要滥用注释，有些非常清晰明确的代码不需要注释
仅在必要的时候注释你的代码，不要太多，并且注释也要简单给力。
论题十： 不要把数值hard-code在代码中，使用const 来定义
论题十一： 不要使用””, 使用string.Empty
正确的：
string name = string.Empty;
不建议：
string name = "";
论题十二： 善于合并if
观察下面这段可爱的代码：
View Code
public bool Equals(CommentData obj) { if (!CommentId.Equals(obj.CommentId)) return false; if (!Comment.Equals(obj.Comment)) return false; if (!CommentorId.Equals(obj.CommentorId)) return false; return true; }
如果我们写成这样会不会好些呢：
View Code
public bool Equals(CommentData obj) { return CommentId == obj.CommentId && Comment.Equals(obj.Comment) && CommentorId == obj.CommentorId; }
观察下面这段可爱的代码：
public bool Equals(CommentData obj) {
if (!CommentId.Equals(obj.CommentId)) return false;
if (!Comment.Equals(obj.Comment)) return false;
if (!CommentorId.Equals(obj.CommentorId)) return false;
return true;
}如果我们写成这样会不会好些呢： public bool Equals(CommentData obj) {
return CommentId == obj.CommentId &&
Comment.Equals(obj.Comment) &&
CommentorId == obj.CommentorId;
}
论题十三： 不断重构你的代码
当有新的需求或新改动的时候，可以拨一些时间来重构。 -- 你可能突然发现，原来重构后的代码可以如此美丽。使用一些重构的插件，比如resharper可以使你事半功倍。
当有新的需求或新改动的时候，可以拨一些时间来重构。 -- 你可能突然发现，原来重构后的代码可以如此美丽。使用一些重构的插件，比如resharper可以使你事半功倍。
未完待继…
-
本文来自: 动态网站制作() 详细出处参考：
