r - 是否可以让RStudio显示自定义函数的函数参数和描述？

Question

RStudio中的代码完成非常棒，我真的很喜欢弹出窗口如何描述函数输入的参数。例如，如果键入matrix(然后按下“ tab”，则会出现matrix()函数的参数列表以及输入说明。假设选择了nrow=，则相邻的窗口将nrow输入描述为“所需的行数”。

我可以让RStudio为我的自定义功能执行此操作吗？我是否必须创建一个程序包才能实现此效果？

假设我有一个充满自定义功能的文件myCustomFunctions.R，我在其中存储了所有其他辅助功能。我希望能够为我的函数添加元数据，以便此帮助程序窗口也描述我的函数输入。

Answer 1

为了增加评论中Hadley的答案，Rstudio正在挖掘帮助文件的特定部分以生成帮助器窗口。具体来说，在括号前的制表符会出现“用法”和“描述”部分，在括号内的制表符会出现逗号，或者在逗号之后出现“参数”部分。因此，不仅需要制作软件包，而且还必须生成帮助文件以利用此功能。