Google 的 R 語(yǔ)言編碼風(fēng)格指南

1、 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 s

2、ame 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, ".&qu

3、ot; 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 書寫風(fēng)格 編碼時(shí)通篇使用一種一致的風(fēng)格來(lái)書寫 TODO. TODO(您的用戶名:

4、 所要采取行動(dòng)的明確描述 5 語(yǔ)言 Attach 使用 attach 造成錯(cuò)誤的可能數(shù)不勝數(shù). 避免使用它. 函數(shù) 錯(cuò)誤 (error 應(yīng)當(dāng)使用 stop( 拋出. 對(duì)象和方法 S 語(yǔ)言中有兩套面向?qū)ο笙到y(tǒng), S3 和 S4, 在 R 中這兩套均可使用. S3 方法的可交互性更強(qiáng), 更加靈活, 反之, S4 方法更加正式和嚴(yán)格. (對(duì)這兩套系統(tǒng)的說(shuō)明, 參見 Thomas Lumley 的文章 "Programmer's Niche: A Simple Class, in S3 and S4", 發(fā) 表 于 R News 4/1, 2004, 33 - 36 頁(yè) :

5、 /doc/Rnews/Rnews_2004-1.pdf. 這里推薦使用 S3 對(duì)象和方法, 除非您有很強(qiáng)烈的理由去使用 S4 對(duì)象和方法. 使用 S4 對(duì)象的一個(gè)主要 理由是在 C+ 代碼中直接使用對(duì)象. 使用一個(gè) S4 泛型/方法的主要理由是對(duì)雙參數(shù)的分發(fā). 避免混用 S3 和 S4: S4 方法會(huì)忽略 S3 中的繼承, 反之亦然. 6 7 8 9 例外 除非有不去這樣做的好理由, 否則應(yīng)當(dāng)遵循以上描述的編碼慣例. 例外包括遺留代碼的維護(hù)和對(duì) 結(jié)語(yǔ) 遵守常識(shí), 前后一致. 第三方代碼的修改. 如果您在編輯現(xiàn)有代碼, 花幾分鐘看看代碼的上下文并

6、弄清它的風(fēng)格. 如果其他人在 if 語(yǔ)句周圍使用了空 格, 那您也應(yīng)該這樣做. 如果他們的注釋是用星號(hào)組成的小盒子圍起來(lái)的, 那您也要這樣寫。 遵循編碼風(fēng)格準(zhǔn)則的意義在于, 人們相當(dāng)于有了一個(gè)編程的通用詞匯表, 于是人們可以專注于您在 說(shuō)什么, 而不是您是 怎么說(shuō) 的. 我們?cè)谶@里提供全局的編碼風(fēng)格規(guī)則以便人們了解這些詞匯, 但局部風(fēng)格也很重 要. 如果您加入文件中的代碼看起來(lái)和周圍的已有代碼截然不同, 那么代碼閱讀者的閱讀節(jié)奏就會(huì)被破壞. 盡量避免這樣做. OK, 關(guān)于如何寫代碼已經(jīng)寫得夠多了; 代碼本身要有趣的多. 編碼愉快! 10 參考文獻(xiàn) 11 http:/www.maths.lth.se/help/R/RCC/ - R 語(yǔ)言編