7

我希望这个问题是主题。

我在进行代码审查时偶然发现了以下功能：

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

此函数用于通过输出参数检索某个类的值xxx和值。yyy

评论（后来用于自动文档）说：

...此函数通过引用返回 [xxx] 和 [yyy]...

显然，该函数返回一个布尔值，指示成功或失败。所以上面那句话需要改写。但是怎么做？什么是正确的术语（如果有的话）通过输出参数返回某些东西，或者换句话说，填充通过引用传递的参数？

这个问题被标记为与语言无关，因为它不是 C++ 特定的。但它也被标记为 C++，因为该示例是用 C++ 编写的。

4

4 回答 4

8

“成功后，SomeFunc存储o_xxx和o_yyy价值观......”；stores in是 Linux 手册页如何strtoul(3)描述该函数对其endptr参数的作用。

虽然我也经常听到带有引用类型输出参数的“return in”这个短语。

于 2012-02-06T10:39:55.137 回答
1

用最简单的话来说：

函数SomeFunc() 可以 修改参数xxx(std::string)并yyy(char) 返回成功或失败（bool）。

于 2012-02-06T10:38:24.290 回答
1

考虑 MSDN 方式。例子。

返回值在其自己的部分中描述。
对输出参数的操作在其自己的部分中进行了描述，并且可以选择在“返回值”部分中重复。

于 2012-02-06T10:42:37.007 回答
1

如果您使用的是 doxygen，那么可以这样做：

/**
 *- Description : This function ...
 *
 * @param[out] xxx ...
 * @param[out] yyy ...
 *
 * @return true for ..., false otherwise
 *
 ***********************************************************************/
于 2012-02-06T11:11:21.553 回答