• 养成C#编程好习惯


    ●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) 自定义异常要继承于ApplicationExcept ion。
    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 l ocation.
    ●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)代码否则不要使用不安全的代码(uns afe 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. 当需要构建长的字符串的时候,使用StringBuil der不要使用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()和Finali ze()两个方法。
    ●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)的数据 结构。
  • 相关阅读:
    java定义类 对象,引用,指针
    java数组 数组工具类Arrays
    java 流程执行 循环 foreach循环
    java注释 命名 数据类型 基本类型转换 位运算符 逻辑运算符 三目运算符
    maven 学习1 -安装maven 并执行编译命令
    Lucene工作原理(转)
    nginx&tomcat实现负载均衡
    nginx安装(centos-7下安装nginx-1.8.1)
    spring中bean的作用域
    Spring管理事务配置的五种方式
  • 原文地址:https://www.cnblogs.com/beniao/p/909815.html
Copyright © 2020-2023  润新知