在 Java 中格式化传递给函数的多个参数

Question

通常，传递给函数的参数数量可能很大。考虑以下情况：

calculate(dataManager.getLastUpdate().getNumberOfChildren(),
          dataManager.getLastUpdate().getNumberOfParents(),
          dataManager.getLastUpdate().getNumberOfGrandChildren(),
          long milliseconds,
          int somethingelse)

Java 中是否有提供对齐参数方法的指南？将所有参数放在一行中看起来不太漂亮。

Answer 1

当我必须调用这样的方法时，我喜欢将参数放在自己的行上，如下所示：

final int result = calculate (
    dataManager.getLastUpdate().getNumberOfChildren(),
    dataManager.getLastUpdate().getNumberOfParents(),
    dataManager.getLastUpdate().getNumberOfGrandChildren(),
    milliseconds,
    somethingelse
);

显然这是个人偏好，但如果您正在与其他人一起编写代码，请尝试遵守已经提出的约定。

Answer 2

根据 Sun 的 Java 编码约定，“换行”部分”：

当表达式无法容纳在一行中时，请根据以下一般原则将其分解：

• 逗号后换行。
• 在运算符之前中断。
• 优先选择较高级别的休息时间而不是较低级别的休息时间。
• 将新行与上一行同一级别的表达式开头对齐。
• 如果上述规则导致代码混乱或代码被挤到右边距，只需缩进 8 个空格即可。

该文档还包括一些方法调用的示例：

function(longExpression1, longExpression2, longExpression3,
         longExpression4, longExpression5);

var = function1(longExpression1,
                function2(longExpression2,
                          longExpression3));

Answer 3

我会把我的小沙粒放在这里，很久以前有一个名叫 Esteban 的开发者
建议我采用这种格式，我首先认为它很难看
一段时间后，没有其他方法可以让我满意：

final int result = calculate (
     dataManager.getLastUpdate().getNumberOfChildren()
     , dataManager.getLastUpdate().getNumberOfParents()
     , dataManager.getLastUpdate().getNumberOfGrandChildren()
     , long milliseconds
     , int somethingelse
     );

我发现这非常清楚，很容易添加/删除新参数，
参数数量清晰，每行只有一个参数，方法调用结束非常清晰，
等等...

定义方法的模式也类似

public int calculate(
    final int numberOfChildren
    , final int numberOfParents
    , final int numberOfGrandChildren
    , final long milliseconds
    , final int somethingelse
    ) throws CalucalteExceptio {

     // MyCode

    }

最终嵌套调用的模式相同，StringBuilder典型序列

   StringBuilder sb = new StringBuilder()
       .append('Children #').append(numberOfChildren).append(NL)
       .append('Parents #').append(numberOfParents).append(NL)
       .append('GrandChildren #').append(numberOfGrandChildren).append(NL)
       ;

我发现的唯一问题是IDE格式化程序从来不允许这种“开头逗号”方法，这非常有趣，还有更多比我尝试过的任何其他内容都可读。

希望它能增加一些有趣的东西

Answer 4

我可以将 getNumberOf*() 方法的返回值分配给变量：

SomeObject lastUpdate = dataManager.getLastUpdate();
int children = lastUpdate.getNumberOfChildren();
int parents = lastUpdate.getNumberOfParents();
int grandChildren = lastUpdate.getNumberOfGrandChildren();
calculate(children, parents, grandChildren, milliseconds, somethingelse);

Answer 5

参考您的示例，Eclipse 和其他 IDE 按照上面的方式对其进行格式化（每行 1 个参数，全部左对齐），通常看起来相当不错。

Answer 6

我完全同意你的例子，每行一个参数，所有参数都排列在彼此下面。

它使得浏览列表以查看有什么或缺少什么变得非常容易。

它还可以更轻松地将空值记录为“// user id”或类似的内容。

我发现它特别容易在视觉上解析，而不是有几行密集的值，这些值通常看起来很相似。