R中的函数注释约定

comment()

attr()

FOO <- function(x,y) {
 x + y 
}

attr(FOO, \"comment\") <- \"FOO performs simple addition\"

#This can be arbitrary. \"comment\" is special. see ?comment for details.
attr(FOO, \"help\") <- \"FOO expects two numbers, and it will add them together\"

attributes()

FOO

> attributes(FOO)
$source
[1] \"function(x,y) {\" \" x + y \"         \"}\"              

$comment
[1] \"FOO performs simple addition\"

$help
[1] \"FOO expects two numbers, and it will add them together\"

> attr(FOO, \"help\")
[1] \"FOO expects two numbers, and it will add them together\"
attr(FOO, \"comment\")
[1] \"FOO performs simple addition\"

comment()

> comment(FOO)
[1] \"FOO performs simple addition\"