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

【问题标题】：Is it possible to get RStudio to show function arguments and descriptions for custom functions?是否可以让 RStudio 显示自定义函数的函数参数和描述？
【发布时间】：2014-02-04 23:13:16
【问题描述】：

RStudio 中的代码完成功能非常棒，我非常喜欢弹出框描述函数输入参数的方式。例如，如果键入matrix( 然后按“制表符”，则会出现matrix() 函数的参数列表以及输入说明。例如，nrow= 被选中，然后相邻窗口将 nrow 输入描述为“所需的行数”。

我可以让 RStudio 为我的自定义函数执行此操作吗？我是否必须创建一个包才能达到这种效果？

假设我有一个包含自定义函数的文件myCustomFunctions.R，并且我将所有杂项辅助函数都存储在其中。我希望能够为我的函数添加元数据，以便此帮助窗口也描述我的函数输入。

【问题讨论】：

目前不可能，除非你创建一个包（但这很容易）
不完全相同，但args 显示您的选项（当然没有描述）

标签： r rstudio

【解决方案1】：

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

【讨论】：

【解决方案2】：

跟进 Hadley：即使这些功能仅供您自己使用，也值得将它们打包。然后，您将免费获得许多有用的东西，超越包文档系统：版本控制、单元测试、可移植性、可共享性……我可以继续。在回到有趣的部分之前，你必须克服一个小的潜在障碍（即破解你自己的整洁的东西），但值得花时间投资。

Hadley 热心公益put his Packages book online，并逐步描述了如何访问我提到的所有好东西。希望你会认为值得付出（我做到了）。

【讨论】：