Google 的 R 语言编码风格指南.docVIP

CalculateSampleCovariance - function(x, y, verbose = TRUE { # Computes the sample covariance between two vectors. # # Args: # # # # # # Returns: # The sample covariance between x and y. x: One of two vectors whose sample covariance is to be calculated. y: The other vector. x and y must have the same length, greater than one, with no missing values. verbose: If TRUE, prints sample covariance; if not, not. Default is TRUE. n - length(x # Error handling if (n = 1 || n != length(y { stop(Arguments x and y have invalid lengths: , length(x, and , length(y, . } if (TRUE %in% is.na(x || TRUE %in% is.na(y { stop( Arguments x and y must not have missing values. } covariance - var(x, y if (verbose cat(Covariance = , round(covariance, 4, .\n, sep = return(covariance } TODO 书写风格 编码时通篇使用一种一致的风格来书写 TODO. TODO(您的用户名: 所要采取行动的明确描述 ? 语言 Attach 使用 attach 造成错误的可能数不胜数. 避免使用它. 函数 错误 (error 应当使用 stop( 抛出. 对象和方法 S 语言中有两套面向对象系统, S3 和 S4, 在 R 中这两套均可使用. S3 方法的可交互性更强, 更加灵活, 反之, S4 方法更加正式和严格. (对这两套系统的说明, 参见 Thomas Lumley 的文章 Programmers Niche: A Simple Class, in S3 and S4, 发 表 于 R News 4/1, 2004, 33 - 36 页 : /doc/Rnews/Rnews_2004-1.pdf. 这里推荐使用 S3 对象和方法, 除非您有很强烈的理由去使用 S4 对象和方法. 使用 S4 对象的一个主要 理由是在 C++ 代码中直接使用对象. 使用一个 S4 泛型/方法的主要理由是对双参数的分发. 避免混用 S3 和 S4: S4 方法会忽略 S3 中的继承, 反之亦然. ? ? ? ? 例外 除非有不去这样做的好理由, 否则应当遵循以上描述的编码惯例. 例外包括遗留代码的维护和对 结语 遵守常识, 前后一致. 第三方代码的修改. 如果您在编辑现有代码, 花几分钟看看代码的上下文并弄清它的风格. 如果其他人在 if 语句周围使用了空 格, 那您也应该这样做. 如果他们的注释是用星号组成的小盒子围起来的, 那您也要这样写。 遵循编码风格准则的意义在于, 人们相当于有了一个编程的通用词汇表, 于是人们可以专注于您在 说什么, 而不是您是 怎么说 的. 我们在这里提供全局的编码风格规则以便人们了解这些词汇, 但局部风格也很重 要. 如果您加入文件中的代码看起来和周围的已有代码截然不同, 那么代码阅读者的阅读节奏就会被破坏. 尽量避免这样做. OK, 关于如何写代码已经写得够多了; 代码本身要有趣的多. 编码愉快! ?? 参考文献 ?? http://www.maths.lth.se/help/R/RCC/ - R 语言编码惯例 / - 为 emacs 用 户 而 生 . 在 您 的 emacs 中 运 行 R 并 且 提 供 了 一 个 emacs mode.