Google の R の書き方案内

以下は, Google's R Style Guideを個人的に日本語に翻訳した文章です. 翻訳に起因する問題は 元のページとは関係がありません.

R は統計の計算や図示に使われる高級プログラミング言語です. この R プログラミングの書き方ガイドの目標は, 私たちの R のコードを読みやすく, 共有しやすく, 検証しやすくすることです. 以下の規則はグーグルでの R 利用者コミュニティ全体と協力して作られました.


  1. 表記法と名前付け
  2. 構文
  3. 構成
  4. 言語
  5. 例外
  6. 上で説明したコードを書く慣例を外れるもっともな 理由がない限りは. この慣例に従う必要がある. 例外を認めるもっともな理由として, レガシーコードや 修正しているサードパーティーのコードも含まれる.

  7. 単語の分け目
  8. 常識を使うことと一貫性を持つこと.

    もしコードを編集するなら, その周辺のコードを しばらく眺めてから, その書式を決めること. もし編集しているコードが if 節の前後に 空白を入れているなら, あなたもそれにならうこと. もし, 編集しているコードは注釈がアスタリスクの四角形で 囲まれているなら, 新たに加える注釈もアスタリスクの 四角形で囲うこと.

    書き方のガイドラインを持つ意義は, コード書きの 共通語彙を持つことで, どうやって書くかに 悩まされることなく何を書きたいかに 集中できることにあります. 広く使われている書き方の規則をここに示したので, その共通語彙はわかるでしょう. しかし, 一部の グループで使われている書き方も重要です. もし, あるファイルに加えようとするコードが 既存のコードから極端に異なっているなら, その不連続性により, そのコードを読もうとするひとを コードの流れの外へと追い出してしまうでしょう. これを避けるよう努力すること. コード書きについては 十分書きました. プログラミングそのものはずっとより 面白いものです. 楽しいコード書きを!

  9. 参考文献
  10. http://www.maths.lth.se/help/R/RCC/ - R コード書きの慣例 (R Coding Conventions)
    http://ess.r-project.org/ - emacs 利用者向け. これは emacs 内 で動作し, emacs モードを持つ.