r - R 中的文档字符串有缺点吗？

Question

我不喜欢评论的自动缩进ESS (Emacs Speaks Statistics) 模式，因为它离右边太远了。

normalize <- function(values){
                                        # comment
  return(2* values / (max(values) - min(values)) )
}

Python 也使用文档字符串作为注释。我在 R 中玩弄它。

normalize <- function(values){
  "comment
   line 2 of comment"
  return(2* values / (max(values) - min(values)) )
}

我确定我也可以修复评论的 ESS 缩进，但我喜欢多行的想法评论。 GNU R 中的文档字符串有什么缺点吗？

Answer 1

以 ## 而不是 # 开头的注释将根据当前缩进级别自动缩进。

j <- function(x) {
                                        # One hash auto-indents to column 40 
    ## Two hashes auto-indent to current level
### Three hashes auto-indent to BOL
    rnorm(x)
}