java - 如何组织方法的最佳实践？

Question

这个问题已经有答案了:

Are there any Java method ordering conventions? [closed] (8 个回答)

已关闭 7 年前。

是否有关于在哪里声明仅在另一个方法中使用(或调用)的方法的标准实践或约定？为了证明这一点，假设如下:

public class MyClass{
    methodA();
    methodB();
    methodC();

    public void methodA(){
        methodA1();
        methodA2();
    }  
    public void methodB(){
        methodB1();
        methodB2();
    }
    private void methodA1(){
        do something;
    }
    private void methodA2(){
        do something;
    }
}

或者，是否有不同的编码方式可以提高上述内容的可读性？我已经阅读过具有类似主题的其他问题，但它们没有解决我的问题，该问题特定于其他方法中使用的方法。您可以假设 methodA、methodB 和 methodC 对于特定任务具有逻辑且有意义的顺序。我的问题是其他方法(methodA1，methodA2，..)在此任务中没有意义，它们仅在调用它们的方法内部才有意义。或者，我根本不应该担心在哪里放置方法声明吗？

Answer 1

Methods should be ordered in such a way so that they read like a story that doesn't cause the reader to need to jump around the code too much

罗伯特·C·马丁(又名鲍勃叔叔)

这意味着(简而言之)，你的 methodA1、methodA2 应该放在 methodA (使用它们的)之后。与方法B方法B1、方法B2相同。我希望看到这样的东西:

public class MyClass {
    methodA();
    methodB();
    methodC();

    public void methodA() {
        methodA1();
        methodA2();
    }

    private void methodA1() {
        do something;
    }
    private void methodA2() {
        do something;
    }

    public void methodB() {
        methodB1();
        methodB2();
    }

    public void methodB1() {
        do something;
    }

    public void methodB2() {
        do something;
    }
}

还建议您将成员变量放在顶部(这样就不会根据访问修饰符做出放置决定)。

您可能想查看鲍勃叔叔的 books或videos获得一些关于编写干净代码的非常好的建议。