是否有任何 Java 方法排序约定?[已关闭]

2022-08-31 06:40:46

我有一个大型类(40种左右的方法),这是我将作为课程作业提交的软件包的一部分。目前,这些方法在公共/私人等实用性方面非常混乱,我想以合理的方式订购它们。有没有一种标准的方法可以做到这一点?例如,通常字段列在方法之前,构造函数列在其他方法之前,getters/setter最后;其余的方法呢?


答案 1
  1. 类(静态)变量:首先是公共类变量,然后是受保护的类变量,然后是私有类变量。

  2. 实例变量:首先是公共变量,然后是受保护变量,然后是私有变量。

  3. 构造 函数

  4. 方法:这些方法应按功能分组,而不是按范围或可访问性分组。例如,私有类方法可以位于两个公共实例方法之间。目标是使阅读和理解代码更容易。

资料来源:https://www.oracle.com/java/technologies/javase/codeconventions-fileorganization.html


答案 2

一些约定首先列出所有公共方法,然后列出所有私有方法 - 这意味着很容易将API与实现分开,即使不涉及接口,如果你明白我的意思。

另一个想法是将相关方法组合在一起 - 这样可以更容易地发现接缝,您可以在其中将现有的大型类拆分为几个更小,更有针对性的类。