Rubyスタイルガイド

これはAirbnbのRubyスタイルガイドです。

これはGithubガイドおよびBozhidar Batsovガイドからインスピレーションを得ました。

目次

1. 空白

   1. インデント
   2. インライン
   3. 改行
2. 行の長さ

3. コメント

   1. ファイル/クラスレベルのコメント
   2. ファンクションのコメント
   3. ブロックおよびインラインのコメント
   4. 句読点、スペル、文法
   5. TODOコメント
   6. コメントアウトされたコード

4. メソッド

   1. メソッドの定義
   2. メソッドの呼び出し

5. 条件式

   1. 条件キーワード
   2. 3項演算子
6. 構文
7. 命名
8. クラス
9. 例外
10. コレクション
11. 文字列
12. 正規表現
13. パーセントリテラル
14. Rails固有
15. 一貫性を保つ

一貫性を保つ

コードを編集している場合は、時間をとって自分の周りのコードを見て、そのスタイルを検討してください。演算子まわりにスペースを使用している場合、自分も使用する必要があります。コメントまわりにハッシュマークの小さなのボックスがある場合、自分のコメントまわりにハッシュマークの小さなのボックスも追加する必要があります。

スタイルガイドを持つポイントは、コーディングの共通した語彙を持ち、人々がそれがどのように言われているかよりも何を言っているかに集中できるようにすることです。人々が語彙を知ることができるように、ここでグローバルなスタイルルールを紹介しますが、ローカルなスタイルも重要です。ファイルに追加するコードがその周りの既存のコードと大幅に異なる場合、読者はそれを読んだときにリズムが崩れます。これを避けてください。

— Google C++スタイルガイド