如何使自定义函数出现注释

Question

使用RStudio我注意到，当调用一个函数时，我可以点击选项卡，弹出窗口将显示可选参数，例如，如果我输入round(并点击标签，则x=和digits=将显示为可能的选项。这也发生在我写的自定义函数中。不同之处在于内置功能弹出窗口也有关于各个参数的评论和解释。是否有可能用自定义函数重新创建这样的行为？

Answer 1

我明白你的意思了。如果你写一个自定义的功能

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

那你去foo(，打标签，代码完成弹出菜单会给你的选项x =和y =。但是，当你键入一个现有研发功能，如round(，不仅选项卡给你的选项，但有一个解释每个变量的下面，告诉你它的功能作用：唯一的办法

我可以考虑这样做，因为你自己的功能是将你的函数打包到你自己定制的包中，并确保“帮助”文档包含你的函数参数。这已经超出了一个*问题的范围，但我会告诉你几个博客，在那里我学习了R包的基础知识。

的Not So Standard Deviation博客介绍了如何编写一个简单的包与帮助文档，而这正是你需要看到您的自定义功能出现与RStudio的自动完成内部解释什么。简而言之，你需要安装roxygen2，devtools，并与每个自定义功能，你需要彻底的评论这样的功能：

（免责声明：傻瓜猫的例子是博客的，不是我的）

Here's a more detailed tutorial关于创建R软件包，以及这里的another blog on getting organised with R packages。祝你好运！