Какой правильный термин для возврата чего-либо в качестве параметра out?

Question

Надеюсь, этот вопрос по теме.

Я делал обзор кода и наткнулся на следующую функцию:

bool SomeFunc(std::string& o_xxx, char& o_yyy);

Эта функция используется для получения значений xxx и yyy некоторого класса с помощью параметров out.

Комментарии (которые позже используются для автоматической документации) говорят:

... эта функция возвращает по ссылке [xxx] и [yyy] ...

Очевидно, что функция возвращает логическое значение, указывающее успех или неудачу. Поэтому вышеприведенное предложение необходимо перефразировать. Но как? Каков правильный термин (если таковой имеется) для возврата чего-либо с помощью параметра out или, другими словами, для заполнения аргумента, переданного по ссылке?

Вопрос помечен как независимый от языка, потому что он не специфичен для C ++. Но он также помечен C ++, потому что пример на C ++.

Answer 1

"В случае успеха SomeFunc сохраняет в o_xxx и o_yyy значения ..."; сохраняет в , как man-страница Linux strtoul(3) описывает, что эта функция делает со своим аргументом endptr.

Хотя я также достаточно часто слышал фразу "return in" со ссылкойпараметры.

Answer 2

Если вы используете Doxygen, то это будет делать:

/**
 *- Description : This function ...
 *
 * @param[out] xxx ...
 * @param[out] yyy ...
 *
 * @return true for ..., false otherwise
 *
 ***********************************************************************/

Answer 3

Рассмотрим способ MSDN. Пример . * +1003 *

Возвращаемое значение описано в его собственном разделе.
Манипуляции с выходными параметрами описаны в их собственных разделах и могут при желании повторяться в разделе «Возвращаемое значение».

Answer 4

Проще говоря:

Функция SomeFunc() может изменить параметры xxx(std::string) и yyy(char) и возвращает успех или неудачу (bool).