如何在Javadocs中正确指定通过参数引用返回

Question

假设我有一个定义的方法foo：

void foo(MyObject a, MyObject b) {
    a.set(1);
    b.set(2);
}

我可以这样称呼foo：

MyObject a = new MyObject();
MyObject b = new MyObject();
foo(a, b);

所以我通过引用传递参数从这个函数“返回”。 如何为此编写Javadoc？

Answer 1

有关示例，请查看List.toArray(T[])的文档：

  

...

     

<强>参数：
  a - 此列表元素所在的数组   存储，如果它足够大;否则，一个新的阵列   为此目的分配相同的运行时类型。

     

...