工人方法通常应放在调用它的方法之上还是之下?

时间:2014-01-07 15:45:04

标签: java methods coding-style refactoring conventions

是否存在关于另一种方法调用的方法是否应该高于或低于它的约定?例如。说caller()被重构为两种方法 - 哪些是aboveCaller()belowCaller()中更标准的位置?

private void aboveCaller() { /*...here?...*/ }

public void caller() {
    aboveCaller();
    belowCaller();
}

private void belowCaller() { /*...or here?...*/ }

虽然这是Java中的,但它是一个通用编程问题,并不是真正针对特定语言。 (如果之前有人问过道歉 - 尝试在这里搜索但没有提出任何建议)。

3 个答案:

答案 0 :(得分:2)

遵循top-down设计,我首先编写方法调用,然后实现它们,因此它们将被置于其中。

其他人更喜欢他们在调用者之上,因为它更清楚(你首先遇到实现,然后看电话)。

有一点可以肯定,请遵循您的惯例。

答案 1 :(得分:2)

我认为没有惯例。但是,我通常在下面放置下面的Caller。它是主要功能的支持功能,我不想看它,直到我在主要功能的内容中遇到它。话虽这么说,我把所有公共功能放在第一位,然后是所有私人功能。我把类变量放在顶部。此外,每个非显而易见的函数的javadoc将有助于理解代码。

答案 2 :(得分:1)

有20个人会回答这个问题,你最终会得到25个不同的答案。

我认为没有标准惯例,而且在Java中并不重要。您可以按字母顺序列出它们,或者将相关方法组合在一起,或者首先列出私有方法,然后列出公共方法,首先列出set setter,然后是getter,或者将getter和setter成对列在一起等等。

除非你的教授或老板已经定义了另一个约定,否则你应该做任何对你来说最自然的事情。

编辑:要查看它是多么随意,请查看右侧“相关”栏中的所有类似问题。