在类中排列变量和方法的最佳方法是什么?

时间:2010-12-21 03:15:00

标签: class variables methods coding-style readability

我通常会安排我的变量和方法:

class MyClass {
    // public variables
    // public methods
    // private methods
    // private variables
}

我想知道在可读性方面定义函数和变量的最佳安排是什么?

编辑:那么类中的枚举和类定义呢?

1 个答案:

答案 0 :(得分:4)

像这样:

class MyClass {
    // private fields
    // public methods
    // private methods
}

您不应该有任何公共字段。改为使用属性。

StyleCop有一个set of rules on suggested code order。见SA1201

  

在类,结构或接口中,元素必须按以下顺序放置:

     
      
  • 字段
  •   
  • 构造
  •   
  • 终结者(破坏者)
  •   
  • 代表
  •   
  • 活动
  •   
  • 枚举
  •   
  • 接口
  •   
  • 属性
  •   
  • 索引器
  •   
  • 方法
  •   
  • 的Structs
  •   
  •   

SA1202

  

要符合此规则,必须按访问级别按以下顺序放置相同类型的相邻元素:

     
      
  • 公开
  •   
  • 内部
  •   
  • protected internal
  •   
  • 保护
  •   
  • 私有
  •   

如果您使用StyleCop,它会在您违反这些规则时发出警告。