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

发布于 2024-10-09 03:55:52 字数 220 浏览 7 评论 0原文

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

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

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

编辑:类中的枚举和类定义又如何?

I usually arrange my variables and methods like this:

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

I want to know what is the best arrangement for defining functions and variables in terms of readability?

EDIT: Also what about enum and class definitions within the class?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

白馒头 2024-10-16 03:55:53

像这样:

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

你不应该有任何公共字段。请改用属性。

StyleCop 有一个 建议代码顺序的规则集。请参阅SA1201

在类、结构或接口中,元素必须按以下顺序定位:

  • 字段
  • 构造函数
  • 终结器(析构函数)
  • 代表
  • 活动
  • 枚举
  • 接口
  • 属性
  • 索引器
  • 方法
  • 结构
  • 课程

SA1202

为了遵守此规则,相同类型的相邻元素必须按访问级别按以下顺序定位:

  • 公开
  • 内部
  • 受保护的内部
  • 受保护
  • 私人

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

Like this:

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

You shouldn't have any public fields. Use properties instead.

StyleCop has a set of rules on suggested code order. See SA1201:

Within a class, struct, or interface, elements must be positioned in the following order:

  • Fields
  • Constructors
  • Finalizers (Destructors)
  • Delegates
  • Events
  • Enums
  • Interfaces
  • Properties
  • Indexers
  • Methods
  • Structs
  • Classes

and SA1202:

To comply with this rule, adjacent elements of the same type must be positioned in the following order by access level:

  • public
  • internal
  • protected internal
  • protected
  • private

If you use StyleCop it will warn you when you break these rules.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文