我希望这个问题是关于主题的。
我正在进行代码审查,并偶然发现了以下功能:
bool SomeFunc(std::string& o_xxx, char& o_yyy);
此函数用于通过out参数检索某些类的xxx
和yyy
的值。
评论(后来用于自动记录)说:
...此函数通过引用返回[xxx]和[yyy] ...
显然,该函数返回一个表示成功或失败的布尔值。所以上面的句子需要改写。但是怎么样?什么是正确的术语(如果有的话),通过out参数返回某些内容,或者换句话说,填充通过引用传递的参数?
问题是标记语言不可知,因为它不是C ++特定的。但它也标记了C ++,因为该示例是在C ++中。
答案 0 :(得分:8)
“成功后,SomeFunc
会在o_xxx
和o_yyy
存储值......”; 中的商店是Linux联机帮助页strtoul(3)
如何描述该函数对其endptr
参数的作用。
虽然我也经常使用参考输入参数听到“返回”这个短语。
答案 1 :(得分:1)
用最简单的话说:
功能
SomeFunc()
可以 修改参数xxx(std::string)
和yyy(char)
并返回成功或失败(bool
)。
答案 2 :(得分:1)
考虑MSDN方式。 Example
返回值在其自己的章节中描述 具有输出参数的操作在它们自己的部分中描述,并且可以在返回值部分中可选地重复。
答案 3 :(得分:1)
如果你正在使用doxygen,那么这样做:
/**
*- Description : This function ...
*
* @param[out] xxx ...
* @param[out] yyy ...
*
* @return true for ..., false otherwise
*
***********************************************************************/