最近在网上发现这篇文章,看看自己的编程习惯掌握了多少?
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。
C# code
public class MyClass {
public readonly int Number;
public MyClass(int someValue)
{
Number = someValue;
}
public const int DaysInWeek = 7;
}
14. 每个假设必须使用Assert检查
a) 平均每15行要有一次检查(Assert)
C# code
using System.Diagnostics;
object GetObject() {…}
object obj = GetObject();
Debug.Assert(obj != null);
15. 代码的每一行都应该通过白盒方式的测试。
16. 只抛出已经显示处理的异常。
17. 在捕获(catch)语句的抛出异常子句中(throw),总是抛出原始异常维护原始错误的堆栈分配。
C# code
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. 在循环中总是显式的初始化引用类型的数组。
C# code
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.
C# code
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 <T>
{
void SomeMethod(T t)
{
object temp = t;
SomeClass obj = (SomeClass)temp;
}
}
// 正确:
class MyClass <T> where T : SomeClass
{
void SomeMethod(T t)
{
SomeClass obj = t;
}
}
64. 在一般情况下不要定影有限制符的接口。接口的限制级别通常可以用强类型来替换之。
public class Customer
{…}
//避免:
public interface IList <T> where T : Customer
{…}
//正确:
public interface ICustomerList : IList <Customer>
{…}
65. 不确定在接口内的具体方法的限制条件。
66. 总是选择使用C#内置(一般的generics)的数据结构。
分享到:
相关推荐
以下是对C#编码标准66条好习惯的详细解释: 1. **命名规范**:变量、函数、类和接口等应使用有意义的命名,遵循驼峰命名法或帕斯卡命名法,避免使用缩写和单字符变量名。 2. **注释**:为关键代码段添加注释,解释...
第十六章 组织应用程序 .198 16.1 基 本 概 念 .198 16.2 使用名字空间 .200 16.3 使用指示符 .203 16.4 程 序 示 例 .206 16.5 小 结 .213 第十七章 文 件 操 作 .215 17.1 .Net 框架结构提供的 I/O ...
在编程领域,尤其是在C#语言中,有时我们需要将阿拉伯数字(即我们日常使用的1, 2, 3等)转换为其对应的中文大写形式。这通常在财务或会计软件中非常常见,因为中国传统的财务记录习惯使用中文大写数字来避免欺诈...
从给定的文件信息来看,这是一份关于C#...总之,这份C#语言参考教程从语言的基础知识出发,逐步深入到高级主题和实战案例,旨在为读者提供全面而深入的C#编程技能,无论是初学者还是有经验的开发者都能从中受益匪浅。
本资料《面向对象程序设计之C#版》由知名计算机科学家Grady Booch编写,旨在通过轻松幽默的方式介绍面向对象编程的核心概念及其在C#中的应用。本书不仅覆盖了面向对象的基本原理,还深入探讨了高级设计模式和技术,...
C#和Java都是当今最流行的面向对象的编程语言,它们在很多方面都有相似之处,但也存在着显著的区别。本文将深入探讨这两者的主要差异,帮助开发者更好地理解和选择合适的语言。 一、入口点定义 在C#中,程序的起点...
《软件开发代码规范C#版》是针对C#编程语言制定的一套详细的编码准则,旨在提高代码的可读性、可维护性和团队协作效率。以下是对规范中主要章节的详细说明: ### 1、命名标准 命名标准是代码规范的核心部分,良好...
通过理解这些基本原理,学习者可以更好地掌握C++中的面向对象编程。 #### 四、第一个简单的程序 - **Hello World程序**:本节将引导读者编写第一个简单的C++程序——通常是一个“Hello World”程序。这个例子不仅...
115. 定制服务器控件[二] 116. 将他们组合起来 117. 小结考试 调试和错误处理 118. 好的编程习惯和编码方式 119. 查找错误 120. 处理错误 121. 写入日志并通知管理员 122. 小...
- **编码规范**:介绍C#编程中的编码标准和最佳实践,包括命名约定、注释风格等。 - **代码习惯**:强调良好的编码习惯的重要性,如保持代码整洁、模块化设计等。 - **实践案例**:通过具体示例展示如何遵循这些编码...
Visual Assist是Visual Studio 2010中的一款著名第三方插件,它极大地提升了开发者的工作效率,特别是在C++, C#和VB.NET等编程语言中的代码编写和编辑体验。这款插件以其丰富的特性集和对Visual Studio IDE的深度...
#### 二十六、基于AO/AE获取要素信息 在ARCGIS中,获取要素信息是进行空间分析的前提。 **获取方法:** 1. **查询要素:** 使用`ISearchCursor`接口获取要素集合。 2. **读取属性:** 通过`IFeature`接口读取要素...
《Pragmatic Unit Testing(单元测试之道)》是《Paagmatic Starter Kit(程序员修炼三部曲)》系列中的一个重要组成部分,专注于教导开发者如何高效、实际地进行单元测试。单元测试是软件开发过程中的关键环节,它...
当你需要从文本中提取特定格式的数字时,比如从字符串`"asdadas123asdasdas456asdasdasd789asdasd"`中提取所有三位数,并将其用括号包围起来,可以采用如下步骤: 1. 在“查找内容”栏输入`[0-9][0-9][0-9]`(表示...
点餐系统毕业设计论文文档主要探讨了一种基于Visual Studio 2008、C#编程语言和SQL Server 2008数据库的团膳系统。该系统旨在满足日益增长的科技文化产品需求,特别是在日常生活中的广泛应用。以下是系统的核心模块...