Как правильно обозначить возвращение через ссылку на аргумент в Javadocs - PullRequest
3 голосов
/ 18 августа 2011

Предположим, у меня есть метод 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);

Так что я "возвращаюсь" из этой функции, передавая аргументы по ссылке. Как мне написать Javadocs для этого?

1 Ответ

3 голосов
/ 18 августа 2011

Например, посмотрите документацию для List.toArray(T[]):

...

Параметры: a - массив, в который входят элементы этого спискахраниться, если он достаточно большой;в противном случае новый массиводин и тот же тип времени выполнения выделен для этой цели.

...

...