【问题标题】:In what order do you put methods in class code?你在类代码中按什么顺序放置方法?
【发布时间】:2010-08-16 12:21:37
【问题描述】:

类可以有静态的、私有的、受保护的、公共的方法。每种方法都用于修改、添加、删除等。

您如何将类代码中的函数分组以使其清晰易读?最佳做法是什么?

谢谢。

【问题讨论】:

  • 只要您的团队选择一种方法并保持一致,这并不重要。
  • 那么,你看到了什么方法呢?谢谢。

标签: coding-style code-structure code-standards


【解决方案1】:

这就是我对 Java 类的做法:

  1. 构造函数
  2. 已实现的公共方法 接口
  3. 重写的公共方法或声明为抽象的方法 扩展类(不是对象,请参阅 下面)
  4. 公共方法(除了 getter/setter/Object 方法)
  5. getter 和 setter,按顺序排列 属性被声明
  6. equals、hashCode 和 toString
  7. 私有方法
  8. 公共静态方法

【讨论】:

    【解决方案2】:

    一个约定不一定适合所有场景 - 通常,在我们的团队中,我们使用 C#,并且我们使用“区域”来对私有字段、静态成员、私有方法、构造函数、受保护方法和公共方法进行分组。顺序并不重要,因为 VS 可以很好地折叠所有区域,给出一个摘要视图。有时,我们也使用“覆盖”和/或“虚拟”区域。它还取决于所讨论的类的复杂性。对于少数复杂的类,您甚至会根据功能找到区域。例如,所有“解析”内容(变量、私有方法、解析中涉及的公共方法)都将集中在一个区域下。最后,目标是拥有可读(可维护)的代码,而“一致性”将是实现这一目标的工具之一——只要团队理解这一点,就不会有任何问题。

    【讨论】:

      猜你喜欢
      • 2017-09-01
      • 2011-02-07
      • 2019-07-05
      • 2013-11-10
      • 2015-12-01
      • 2022-08-23
      • 1970-01-01
      • 1970-01-01
      • 2015-11-01
      相关资源
      最近更新 更多