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. 三元運算子
6. 語法
7. 命名
8. 類別
9. 例外
10. 集合
11. 字串
12. 正規表達式
13. 百分比字面值
14. Rails 特定
15. 保持一致性

保持一致性

如果您正在編輯程式碼，請花幾分鐘看看周圍的程式碼，並確定其風格。如果他們在所有算術運算符周圍都使用空格，您也應該這樣做。如果他們的註解周圍有小小的井字號框，那麼您的註解也應該有小小的井字號框。

制定風格指南的目的是為了讓程式碼有一個共同的詞彙，讓大家可以專注於您要表達的內容，而不是您如何表達。我們在這裡介紹全局風格規則，以便大家了解詞彙，但局部風格也很重要。如果您添加到檔案中的程式碼與周圍現有的程式碼看起來差異很大，那麼當讀者閱讀時會被打亂節奏。請避免這種情況。

— Google C++ 風格指南