7

この質問が話題になることを願っています。

私はコードレビューを行っていて、次の機能に出くわしました:

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

この関数は、out パラメーターを使用してクラスの値xxxを取得するために使用されます。yyy

コメント (後で自動ドキュメンテーションに使用されます) は次のように述べています。

... この関数は参照によって [xxx] と [yyy] を返します...

明らかに、関数は成功または失敗を示すブール値を返します。したがって、上記の文は言い換える必要があります。しかし、どのように？out パラメーターを使用して、いわば何かを返すこと、つまり、参照によって渡された引数を入力することの正しい用語は (もしあれば) ?

この質問は、C++ 固有ではないため、言語に依存しないタグが付けられています。ただし、例が C++ であるため、C++ のタグも付けられています。

4

4 に答える 4

8

"成功すると、次の値に格納SomeFuncされます ..."; store inは、その関数がその引数で何をするかをLinux のマンページがどのように説明しているかです。o_xxxo_yyystrtoul(3)endptr

また、参照型の out パラメータを使用して「return in」というフレーズをよく耳にします。

于 2012-02-06T10:39:55.137 に答える
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 に答える
1

最も簡単な言葉で：

関数SomeFunc() は パラメーターを変更でき、 成功または失敗を返します ( )。xxx(std::string)yyy(char)bool

于 2012-02-06T10:38:24.290 に答える