뭔가를 out 매개 변수로 반환하는 올바른 용어는 무엇입니까?

Question

이 질문이 주제가되기를 바랍니다.

나는 다음과 같은 기능에 코드 리뷰를하고 발견 :이 기능은 출력 매개 변수에 의해 xxx 일부 클래스의 yyy의 값을 검색하는 데 사용됩니다

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

.

(나중에 자동 문서에 사용되는) 주석은 말 : 참조로

...이 함수가 반환 [XXX] 및 [YYY] ...

분명히을 이 함수는 성공 또는 실패를 나타내는 부울 값을 반환합니다. 그러므로 위의 문장을 다시 말해야합니다. 그러나 어떻게? out을 매개 변수로 사용하여 반환하거나, 참조로 전달 된 인수를 채우는 올바른 용어는 무엇입니까?

질문은 C++과 관련이 없으므로 언어에 구속받지 않습니다. 그러나 예제는 C++이기 때문에 C++로 태그도 붙였습니다. 간단하게 말하면

Answer 1

"성공하면, o_xxx 및 o_yyy 값에 SomeFunc 저장 ..."; 은에 저장됩니다. 리눅스 맨 페이지 strtoul(3)은 그 함수가 무엇을 의미 하는지를 endptr 인수로 설명합니다.

참조 입력 매개 변수로 종종 "return in"이라는 문구를 자주 들었지만

Answer 2

:

기능 SomeFunc()는는 매개 변수 xxx(std::string) 및 yyy(char) 을 수정하고 성공 또는 실패 (bool)를 반환 할 수 있습니다.

Answer 3

MSDN 방식을 고려하십시오. Example.

반환 값은 자체 섹션에서 설명합니다.
출력 매개 변수가있는 조작은 자체 섹션에서 설명하며 반환 값 섹션에서 선택적으로 반복 할 수 있습니다. 당신은 doxygen이를 사용하는 경우

Answer 4

, 다음이 할 것 :

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