在类结构方面,是否有一个官方的c#项目顺序指南?

它是这样的:

公共字段 私有字段 属性 构造函数 方法 ?

我很好奇物品的摆放顺序是否有硬性规定?我有点到处都是。我想坚持一个特定的标准,这样我就可以在任何地方使用它。

真正的问题是我的更复杂的属性最终看起来很像方法,它们在构造函数之前的顶部感觉不合适。

任何建议/建议吗?


当前回答

根据StyleCop规则文档,排序如下。

在类、结构或接口中:(SA1201和SA1203)

常数字段 字段 构造函数 终结器(析构函数) 代表 事件 枚举 接口(接口实现) 属性 索引器 方法 结构体 类

在这些组中,按访问顺序排序:(SA1202)

公共 内部 保护内部 受保护的 私人

在每个访问组中,依次按静态、非静态排序:(SA1204)

静态 非静态

在每个静态/非静态字段组中,按只读、非只读顺序排列:(SA1214和SA1215)

只读的 non-readonly

展开的列表有130行长,所以这里就不展开了。展开的方法部分为:

公共静态方法 公共方法 内部静态方法 内部方法 受保护的内部静态方法 受保护的内部方法 受保护的静态方法 受保护的方法 私有静态方法 私有方法

文档指出,如果规定的顺序不合适——比如,正在实现多个接口,并且接口方法和属性应该分组在一起——那么使用分部类将相关的方法和属性分组在一起。

其他回答

从StyleCop

私有字段,公共字段,构造函数,属性,公共方法,私有方法

由于StyleCop是MS构建过程的一部分,您可以将其视为事实上的标准

我尽量让它简单(至少对我来说)

枚举 声明 构造函数 覆盖 方法 属性 事件处理程序

不是按可见性或按项目类型(字段、属性、方法等)分组,而是按功能分组呢?

最接近的可能是Brad Abrams的《设计指南、托管代码和。net框架》(http://blogs.msdn.com/brada/articles/361363.aspx)

这里概述了许多标准。我认为相关的章节是2.8。

我知道这是旧的,但我的命令如下:

公共的,受保护的,私人的,内部的,抽象的

常量 静态变量 字段 事件 构造函数(s) 方法 属性 代表

我还喜欢像这样写出属性(而不是简写方法)

// Some where in the fields section
private int someVariable;

// I also refrain from
// declaring variables outside of the constructor

// and some where in the properties section I do
public int SomeVariable
{
    get { return someVariable; }
    set { someVariable = value; }
}