R中多行函数的注释协议

R中多行函数的注释协议,r,function,comments,R,Function,Comments,我知道,如果我们想对R中的一行代码进行注释,我们将使用以下格式 my.object <- function(A = arg(1)) #Comment my.object您必须使用双引号来注释多行代码: "my.object <- function(A = arg(1), B = arg(2), C = arg(3), D = arg(4))" “my.object您可以在任意位置进行注释(实际上您不需要空格。解析器忽略从散列到下一个换行符的所

我知道,如果我们想对R中的一行代码进行注释,我们将使用以下格式

my.object <- function(A = arg(1))  #Comment

my.object您必须使用双引号来注释多行代码:

"my.object <- function(A = arg(1), B = arg(2),
                  C = arg(3), D = arg(4))"

“my.object您可以在任意位置进行注释(实际上您不需要空格。解析器忽略从散列到下一个换行符的所有内容。它们只为我们人类提供:

my.object <- function(A = arg(1), B = arg(2),  # First two args
                      C = arg(3), D = arg(4))  # Second two and closing paren  
 {}

my.object另一种可能是-

"This function takes 4 args
and does something"
my.object <- function(A = arg(1), B = arg(2),
                      C = arg(3), D = arg(4))
“此函数包含4个参数
做了些什么“

my.object一个好的做法是包含多行注释,如“双引号内的一些注释”“解释下面的函数。他指的是他在代码中的注释放在哪里。该函数不能被注释掉。很抱歉,但这怎么比使用带有
#
的实际注释更好?@Roland这只是多余的天赋。个人订阅42-”的答案。只是提供生成多行注释的替代方法。
"This function takes 4 args
and does something"
my.object <- function(A = arg(1), B = arg(2),
                      C = arg(3), D = arg(4))
if(FALSE){
"We have a function below that takes 4 arguments
and does something"
}
my.object <- function(A = arg(1), B = arg(2),
                      C = arg(3), D = arg(4))