如何从自定义函数中显示注释

Question

使用RStudio我注意到，在调用一个函数时，我可以点击tab，然后会出现一个弹出窗口，其中包含可以选择的参数，例如：如果我输入round(并点击标签，x=和digits=将作为可能的选择出现。我写的自定义函数也会发生这种情况。不同之处在于内置函数弹出窗口还有关于各个参数的注释和解释。是否可以使用自定义函数重新创建此类行为？

Answer 1

我明白你的意思了。如果您编写自定义函数

foo = function(x,y) { ... }

然后您转到foo(并点击标签，代码完成弹出式菜单会为您提供选项x =和y =。但是，当您键入现有的R函数（例如round(）时，tab不仅会为您提供选项，而且每个变量下面都有一个解释，告诉您它在函数中的作用：

我能想到为自己的功能执行此操作的唯一方法是将您的函数打包到您自己的自定义包中，并确保“帮助”文档包含您的函数参数。这超出了stackoverflow问题的范围，但我会指出几个博客，在那里我学习了R包的基础知识。

Not So Standard Deviation博客解释了如何使用帮助文档编写一个简单的包，这正是您需要看到自定义函数出现在RStudio的自动完成内的解释。简而言之，您需要安装roxygen2，devtools，并且对于每个自定义函数，您需要彻底评论此功能：

（免责声明：高飞猫的例子是博主，不是我的）

关于创建R包的

Here's a more detailed tutorial，这里是another blog on getting organised with R packages。祝你好运！