写C#代码时应养成的好习惯

1. 类名和方法名使用Pascal 大小写形式

public class HelloWorld{ void SayHello(string name) { ... }}

2. 变量和方法参数使用Camel 大小写形式

public class HelloWorld{ int totalCount = 0; void SayHello(string name) { string fullMessage = "Hello " + name; ... }}

3. 不要使用匈牙利方法来命名变量
以前,多数程序员喜欢它-把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如:

string m_sName;int nAge;

然而,这种方式在.NET编码规范中是不推荐的。所有变量都用camel 大小写形式,而不是用数据类型和m_来作前缀。

4. 文件名要和类名匹配
例如,对于类HelloWorld, 相应的文件名应为 helloworld.cs

5. 不使用条件赋值语句。

6. 避免使用大文件。如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。

7. 避免写太长的方法。一个典型的方法代码在1~25行之间。如果一个方法发代码超过25行,应该考虑将其分解为不同的方法。

8. 使用C# 或 VB.NET的特有类型,而不是System命名空间中定义的别名类型。

Good:int age; string name; object contactInfo;

Bad:Int16 age; String name; Object contactInfo;

9. 必要时使用enum 。别用数字或字符串来指示离散值。

10. 变量名以其所属类型缩写(3个字母)开头,整个变量名也遵守camel方式。如布尔值变量blnIsValid

11. 布尔变量名应该包含Is,这意味着Yes/No或True/False值

12. 在发布源代码的硬拷贝版本时使用特定的字体以及字号(新宋体、小五号)。

13. 避免杂乱的注释,如一整行星号。而是应该使用空白将注释同代码分开。

14. 类名中尽量不要出现下划线

15. 实现类似功能的文件应该放在同一个文件夹中或者同一个项目中

16. 尽量保持函数只有一个出口,即只有一处return语句(用临时变量实现)

17. 在类的成员函数中如果存在着相同的代码,则将其抽取成为private的成员函数,以减少代码的冗余,保持在一个类中没有相同的两份代码的副本

18. 避免将多个类放在一个文件里面

19. 避免在条件语句中调用返回bool值的函数。可以使用局部变量并检查这些局部变量。

20. 避免在结构里面提供方法。

21. 除非在构造函数中调用其他构造函数否则不要使用this指针。

posted @ 2009-01-08 16:54  cindymeng  阅读(188)  评论(0编辑  收藏  举报