Question

我经常在我的代码中使用用户定义的函数。 RStudio支持使用Tab键自动完成代码。我发现这很神奇，因为我总能快速阅读函数/调用（...）中的内容。

但是，我的用户定义函数只显示参数，没有其他信息，显然没有帮助页面。这对我来说并不是那么痛苦，但我想分享代码，我认为除了每行中的#coments之外，还有一些信息是有用的。

如今，当我分享时，我的线条通常看起来像这样

myfun <- function(x1,x2,x3,...){

# This is a function for this and that

# x1 is a factor, x2 is an integer ...
# This line of code is useful for transformation of x2 by x1
  some code here
# Now we do this other thing
  more code
# This is where the magic happens
  return (magic)
}

我认为这个逐行评论很棒，但我想改进它，并像其他所有功能一样方便。

Answer 1

不是一个真正的答案，但是如果你有兴趣进一步探讨这个问题，你应该从rcompgen - 帮助页面开始（虽然这不是一个函数名称），还要检查代码：

rc.settings

此外，通过执行此操作，您可以查看当前加载的包中.CompletionEnv的内容：

names(rc.status())
#-----
 [1] "attached_packages" "comps"             "linebuffer"        "start"            
 [5] "options"           "help_topics"       "isFirstArg"        "fileName"         
 [9] "end"               "token"             "fguess"            "settings"

如果你只看：

rc.status()$help_topics

...您会看到制表符完成机制用于匹配的字符项。目前我的机器上有8881个项目。

在R中编写用户定义函数的帮助信息

1 个答案: