你如何在C#3.0中安排源代码元素?

时间:2009-04-15 09:25:17

标签: c# .net oop c#-3.0

以下看起来不错吗?

编辑:选项本质上是通用的,在C#元素方面可能并不详尽。

单一来源文件可以包含以下内容:

注意:

文件可以成对出现 - 可编辑+生成 单个文件只能有一个名称空间。

文件:选项-1

  • 每个文件一个部分或全部类
  • 每个文件零或更多枚举
  • 每个文件零个或多个结构
  • 每个文件零个或多个委托类型

文件:选项-2

  • 每个文件一个或多个接口

文件:选项-3

  • 每个文件一个静态类

在课堂内:选项-1

给定的订单中会有以下部分。

枚举 - 字段 - 属性 - 事件 - 代表 - 方法

在每个部分中,元素将按可访问性排序,即公共方法将出现在私有方法之前。内部类型可以在任意两个部分之间具有自己的部分。可选地,相关字段和属性可以组合在一起。

在课堂内:选项-2

将密切相关的元素分组,而不考虑可访问性级别。使用区域不会失败。

在课堂内:选项-3

只是不在乎。让VS帮助你。

你们有什么想法和做法?

6 个答案:

答案 0 :(得分:3)

每个文件只有一个element。如果你需要将它们组合起来整理它们,那么这就是命名空间的用途。

我也倾向于在类的顶部粘贴字段和属性,然后是构造函数,然后是方法。我通常会将私有方法放在使用它们的公共方法旁边。

编辑:在任何情况下都不应该使用区域!永远。一点都不如果你的课程如此之大,你需要将其中很大一部分崩溃,你需要担心的问题要严重得多。

答案 1 :(得分:2)

我通常将类型放在他们的单独文件中。 (枚举,结构,类和委托)嵌套类型与其父类型在同一文件中。 部分文件仅用于生成的文件。

在文件中,主要结构是:

  • 嵌套类
  • Consts,fields,event和delegate fields
  • 属性
  • 构建函数
  • 终结
  • 方法(相关的方法彼此接近,不一定按accessibillity分组。)

我对这些规则不太严格。他们是指导方针......

答案 2 :(得分:0)

我使用文件:选项-3 和“在课堂内:选项-1”+ “在课堂内:选项-2 ”的混合取决于班级类型。如果有明确的关系,那么我会选择2,但大部分时间我都坚持使用Option-1。

答案 3 :(得分:0)

我通常在文件中使用Option-3,在类中使用Option-1。课程由以下地区构成:

  • 嵌套类
  • 常数
  • 活动/代表
  • Fields
  • 建筑/销毁/最终确定
  • 属性
  • 方法

答案 4 :(得分:0)

我也会在每个文件中只放一个元素。如果元素位于自己的文件中,则更容易找到,特别是在大型项目中。

答案 5 :(得分:0)

罗伯特C马丁的书清洁代码提供了一些有用的指导 - 虽然内容是针对Java的,但我发现该指南仍然非常适用于.NET。

最重要的是选择一种风格并坚持下去。 StyleCop对于执行这些规则非常有用。