草庐IT

c++ - 将函数参数标识为输入或输出

coder 2024-02-19 原文

所以我有一个简单的函数和一些文档: 

/**
 *  @param[out] dest is overwritten by the second argument
 *  @param[in] src is value to overwrite the first argument with
 */
void Copy(int &dest, int src) { dest = src; }

可能不是很有用，但很明显 dest 是输出的。但是，使用指针对我来说这条线变得模糊了:

void Copy(int *dest, int src) { *dest = src; }

dest 应该还是一个输出吗？指针的值不会被修改，只有它指向的内存中的值会被修改。但我仍然会说可能是的。继续:

void Write(FILE *fw, int src) { fwrite(&src, sizeof(src), 1, fw); }

现在这对我来说真的很可疑，我会将 fw 标记为输入，尽管它在逻辑上是输出并且 FILE 结构的内容也会被修改在这个过程中(但那个对我来说很不透明)。

另一方面:

void Open(FILE &*fw, const char *filename) { fw = fopen(filename, "w"); }

是明确输出。 FILE句柄由函数初始化，指针的值被覆盖。

将参数标记为输出是否有好的经验法则或推理？

我什至不想像 C++ 那样进入 [in,out] 参数，那些基本上都是 [out] 参数(例如，如果传递输出通过 std::vector，函数需要获取一个实例作为输入，输出甚至可以重用存储。

最佳答案

Opinions vary关于是否甚至应该使用输出参数，更不用说应该如何记录它们了。尽管如此，它们仍被普遍使用，您的问题是有效的。

参数是否应该标记为[in]、[out] 或[in,out] 取决于其用途参数。

通常，输出参数的目的是允许被调用函数在单个返回值不足时将附加信息传递给调用函数。此“附加信息”通过调用函数提供的引用参数传递。可以使用 C++ 引用运算符 (&) 或指针提供引用参数，这两种方式略有不同，但结果相同。

所以如果参数的目的是允许被调用函数向调用函数提供信息，那么它应该在文档中被标识为输出。

如果通过参数向函数提供了文件句柄或文件名，那么即使该函数旨在写入文件，也将被视为输入 参数。这是因为

  • 函数没有通过参数将信息传回调用例程
  • 写入文件被认为是 side-effect的功能。

如果引用参数用于双向传递信息，则应将其记录为[in,out]。

进一步

在记录函数时，将函数视为提供给调用者的服务。您的文档的读者是编写将调用您的函数的代码的程序员。编写文档时，就好像您(函数的作者)不知道调用代码的上下文或细节一样。文档的目的是概括描述该函数的作用，以及详细说明如何使用该函数。

所以如果函数的设计者打算将dest作为输出，就应该将其标记为输出。您还应该考虑调用者对通过该输出提供的数据不感兴趣的情况。通常这是由调用者提供一个空指针作为该参数的参数来指示的。在将任何数据写入 *dest 之前，您的函数应该进行测试以确保 dest 不为空。参数 dest 的文档应该说明如果 dest 是空指针，则不会写入任何数据。

对输入指针参数使用 const

顺便说一句，如果指针参数仅用于输入，则应使用 const 关键字修改该参数，如下所示:

void Copy(int *dest, const int *src) { *dest = *src; }

这有以下好处:

  • 它将阻止Copy 函数写入*src 位置，如果Copy 函数的程序员错误地尝试那样做
  • 它通知并向编写调用 Copy 的代码的程序员保证他的 src 缓冲区是安全的，不会被 Copy 修改
  • 它是自文档的，如果你在使用const时保持一致:标记为const的指针参数显然是input-only，而指针参数是未标记 const 可能用于输出。

另见

关于c++ - 将函数参数标识为输入或输出，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/34252358/

amp43codedestsectionc++doxygen

有关c++ - 将函数参数标识为输入或输出的更多相关文章

  1. ruby - 检查 "command"的输出应该包含 NilClass 的意外崩溃 - 2

    为了将Cucumber用于命令行脚本，我按照提供的说明安装了arubagem。它在我的Gemfile中，我可以验证是否安装了正确的版本并且我已经包含了require'aruba/cucumber'在'features/env.rb'中为了确保它能正常工作，我写了以下场景:@announceScenario:Testingcucumber/arubaGivenablankslateThentheoutputfrom"ls-la"shouldcontain"drw"假设事情应该失败。它确实失败了，但失败的原因是错误的:@announceScenario:Testingcucumber/ar

  2. ruby-on-rails - 如何在 ruby​​ 中使用两个参数异步运行 exe？ - 2

    exe应该在我打开页面时运行。异步进程需要运行。有什么方法可以在ruby​​中使用两个参数异步运行exe吗？我已经尝试过ruby​​命令-system()、exec()但它正在等待过程完成。我需要用参数启动exe，无需等待进程完成是否有任何ruby​​gems会支持我的问题？ 最佳答案 您可以使用Process.spawn和Process.wait2:pid=Process.spawn'your.exe','--option'#Later...pid,status=Process.wait2pid您的程序将作为解释器的子进程执行。除

  3. ruby-on-rails - 如何优雅地重启 thin + nginx？ - 2

    我的瘦服务器配置了nginx，我的ROR应用程序正在它们上运行。在我发布代码更新时运行thinrestart会给我的应用程序带来一些停机时间。我试图弄清楚如何优雅地重启正在运行的Thin实例，但找不到好的解决方案。有没有人能做到这一点？ 最佳答案 #Restartjustthethinserverdescribedbythatconfigsudothin-C/etc/thin/mysite.ymlrestartNginx将继续运行并代理请求。如果您将Nginx设置为使用多个上游服务器，例如server{listen80;server

  4. ruby - 通过 erb 模板输出 ruby​​ 数组 - 2

    我正在使用puppet为ruby​​程序提供一组常量。我需要提供一组主机名，我的程序将对其进行迭代。在我之前使用的bash脚本中，我只是将它作为一个puppet变量hosts=>"host1,host2"我将其提供给bash脚本作为HOSTS=显然这对ruby​​不太适用——我需要它的格式hosts=["host1","host2"]自从phosts和putsmy_array.inspect提供输出["host1","host2"]我希望使用其中之一。不幸的是，我终其一生都无法弄清楚如何让它发挥作用。我尝试了以下各项:我发现某处他们指出我需要在函数调用前放置“function_”……这

  5. ruby - RSpec - 使用测试替身作为 block 参数 - 2

    我有一些Ruby代码，如下所示:Something.createdo|x|x.foo=barend我想编写一个测试，它使用double代替block参数x，这样我就可以调用:x_double.should_receive(:foo).with("whatever").这可能吗？ 最佳答案 specify'something'dox=doublex.should_receive(:foo=).with("whatever")Something.should_receive(:create).and_yield(x)#callthere

  6. ruby - 如何在 Ruby 中拆分参数字符串 Bash 样式？ - 2

    我正在为一个项目制作一个简单的shell，我希望像在Bash中一样解析参数字符串。foobar"helloworld"fooz应该变成:["foo","bar","helloworld","fooz"]等等。到目前为止，我一直在使用CSV::parse_line，将列分隔符设置为""和.compact输出。问题是我现在必须选择是要支持单引号还是双引号。CSV不支持超过一个分隔符。Python有一个名为shlex的模块:>>>shlex.split("Test'helloworld'foo")['Test','helloworld','foo']>>>shlex.split('Test"

  7. ruby - 在没有 sass 引擎的情况下使用 sass 颜色函数 - 2

    我想在一个没有Sass引擎的类中使用Sass颜色函数。我已经在项目中使用了sassgem，所以我认为搭载会像以下一样简单:classRectangleincludeSass::Script::FunctionsdefcolorSass::Script::Color.new([0x82,0x39,0x06])enddefrender#hamlengineexecutedwithcontextofself#sothatwithintemlateicouldcall#%stop{offset:'0%',stop:{color:lighten(color)}}endend更新:参见上面的#re

  8. ruby - 检查方法参数的类型 - 2

    我不确定传递给方法的对象的类型是否正确。我可能会将一个字符串传递给一个只能处理整数的函数。某种运行时保证怎么样？我看不到比以下更好的选择:defsomeFixNumMangler(input)raise"wrongtype:integerrequired"unlessinput.class==FixNumother_stuffend有更好的选择吗？ 最佳答案 使用Kernel#Integer在使用之前转换输入的方法。当无法以任何合理的方式将输入转换为整数时，它将引发ArgumentError。defmy_method(number)

  9. ruby - 如何进行排列以有效地定制输出 - 2

    这是一道面试题，我没有答对，但还是很好奇怎么解。你有N个人的大家庭，分别是1,2,3,...,N岁。你想给你的大家庭拍张照片。所有的家庭成员都排成一排。“我是家里的friend，建议家庭成员安排如下:”1岁的家庭成员坐在这一排的最左边。每两个坐在一起的家庭成员的年龄相差不得超过2岁。输入:整数N，1≤N≤55。输出:摄影师可以拍摄的照片数量。示例->输入:4，输出:4符合条件的数组:[1,2,3,4][1,2,4,3][1,3,2,4][1,3,4,2]另一个例子:输入:5输出:6符合条件的数组:[1,2,3,4,5][1,2,3,5,4][1,2,4,3,5][1,2,4,5,3][

  10. ruby-on-rails - 在默认方法参数中使用 .reverse_merge 或 .merge - 2

    两者都可以defsetup(options={})options.reverse_merge:size=>25,:velocity=>10end和defsetup(options={}){:size=>25,:velocity=>10}.merge(options)end在方法的参数中分配默认值。问题是:哪个更好？您更愿意使用哪一个？在性能、代码可读性或其他方面有什么不同吗？编辑:我无意中添加了bang(!)...并不是要询问nobang方法与bang方法之间的区别 最佳答案 我倾向于使用reverse_merge方法:option

随机推荐