如何让评论出现在自定义函数中
how to make comments appear from custom functions
使用 RStudio 我注意到,在调用函数时,我可以点击选项卡,然后会出现一个弹出窗口,其中包含可以选择的可能参数,例如如果我输入 round(
并点击 Tab,x=
和 digits=
将作为可能的选项出现。这也发生在我编写的自定义函数中。不同之处在于,内置函数弹出窗口还对各个参数进行了注释和解释。是否也可以使用自定义函数重新创建这种行为?
我明白你的意思了。如果你写一个自定义函数
foo = function(x,y) { ... }
然后您转到 foo(
并点击 Tab,代码完成弹出菜单将为您提供选项 x =
和 y =
。但是,当您键入现有的 R 函数(例如 round(
)时,不仅 Tab 键会为您提供选项,而且每个变量下方都有解释,告诉您它在函数中的作用:
我能想到的对您自己的函数执行此操作的唯一方法是将您的函数打包到您自己的自定义包中,并确保 "help" 文档包含您的函数参数。这超出了 Whosebug 问题的范围,但我会向您指出几个博客,我在这些博客中学习了 R 包的基础知识。
Not So Standard Deviation 博客通过帮助文档 解释了如何编写一个简单的程序包,这正是您在 RStudio 的自动完成中看到您的自定义函数和解释所需要的.简而言之,您需要安装 roxygen2
、devtools
,并且对于每个自定义函数,您都需要像这样对函数进行彻底注释:
(免责声明:傻猫的例子是博主的,不是我的)
Here's a more detailed tutorial on creating R packages, and here's another blog on getting organised with R packages。祝你好运!
使用 RStudio 我注意到,在调用函数时,我可以点击选项卡,然后会出现一个弹出窗口,其中包含可以选择的可能参数,例如如果我输入 round(
并点击 Tab,x=
和 digits=
将作为可能的选项出现。这也发生在我编写的自定义函数中。不同之处在于,内置函数弹出窗口还对各个参数进行了注释和解释。是否也可以使用自定义函数重新创建这种行为?
我明白你的意思了。如果你写一个自定义函数
foo = function(x,y) { ... }
然后您转到 foo(
并点击 Tab,代码完成弹出菜单将为您提供选项 x =
和 y =
。但是,当您键入现有的 R 函数(例如 round(
)时,不仅 Tab 键会为您提供选项,而且每个变量下方都有解释,告诉您它在函数中的作用:
我能想到的对您自己的函数执行此操作的唯一方法是将您的函数打包到您自己的自定义包中,并确保 "help" 文档包含您的函数参数。这超出了 Whosebug 问题的范围,但我会向您指出几个博客,我在这些博客中学习了 R 包的基础知识。
Not So Standard Deviation 博客通过帮助文档 解释了如何编写一个简单的程序包,这正是您在 RStudio 的自动完成中看到您的自定义函数和解释所需要的.简而言之,您需要安装 roxygen2
、devtools
,并且对于每个自定义函数,您都需要像这样对函数进行彻底注释:
(免责声明:傻猫的例子是博主的,不是我的)
Here's a more detailed tutorial on creating R packages, and here's another blog on getting organised with R packages。祝你好运!