使用 UTF-8 作為源文件編碼。
每個縮進級別使用兩個 spaces （又名軟 tabs）. 不要硬 tabs
# bad - four spaces def some_method do_something end # good def some_method do_something end
使用 Unix-風格 換行符。(*BSD/Solaris/Linux/OSX 用戶被為默認涵蓋，Windows 用戶必須特別小心.)
如果你正在使用 Git 你可能會想要添加下面的配置設置來保護你的項目（避免）Windows 蔓延過來的換行符:
$ git config --global core.autocrlf true
不用使用 ; 來分割語句和表達式。以此推論 - 一行使用一個表達式
# bad puts 'foobar'; # superfluous semicolon puts 'foo'; puts 'bar' # two expression on the same line # good puts 'foobar' puts 'foo' puts 'bar' puts 'foo', 'bar' # this applies to puts in particular
對于沒有內容的類定義，盡可能使用單行類定義形式.
# bad class FooError < StandardError end # okish class FooError < StandardError; end # good FooError = Class.new(StandardError)
避免單行方法。即便還是會受到一些人的歡迎，這里還是會有一些古怪的語法用起來很容易犯錯.
無論如何 - 應該一行不超過一個單行方法.
# bad def too_much; something; something_else; end # okish - notice that the first ; is required def no_braces_method; body end # okish - notice that the second ; is optional def no_braces_method; body; end # okish - valid syntax, but no ; make it kind of hard to read def some_method() body end # good def some_method body end
空方法是這個規則的例外。
# good def no_op; end
操作符旁的空格，在逗號，冒號和分號后；在 { 旁和在 } 之前，大多數空格可能對 Ruby 解釋（代碼）無關，但是它的恰當使用是讓代碼變得易讀的關鍵。
sum = 1 + 2 a, b = 1, 2 1 > 2 ? true : false; puts 'Hi' [1, 2, 3].each { |e| puts e }唯一的例外是當使用指數操作時：
# bad e = M * c ** 2 # good e = M * c**2
{ 和 } 值得額外的澄清，自從它們被用于 塊 和 hash 字面量，以及以表達式的形式嵌入字符串。
對于 hash 字面量兩種風格是可以接受的。
# good - space after { and before } { one: 1, two: 2 } # good - no space after { and before } {one: 1, two: 2} 第一種稍微更具可讀性（并且爭議的是一般在 Ruby 社區里面更受歡迎）。
第二種可以增加了 塊 和 hash 可視化的差異。
無論你選哪一種都行 - 但是最好保持一致。
目前對于嵌入表達式，也有兩個選擇：
# good - no spaces "string#{expr}" # ok - arguably more readable "string#{ expr }" 第一種風格極為流行并且通常建議你與之靠攏。第二種，在另一方面，（有爭議）更具可讀性。
如同 hash - 選取一個風格并且保持一致。
沒有空格 (, [之后或者 ], )之前。
some(arg).other [1, 2, 3].length ! 之后沒有空格 . # bad ! something # good !something
when和case 縮進深度一致。我知道很多人會不同意這點，但是它是"The Ruby Programming Language" 和 "Programming Ruby"中公認的風格。
# bad case when song.name == 'Misty' puts 'Not again!' when song.duration > 120 puts 'Too long!' when Time.now.hour > 21 puts "It's too late" else song.play end # good case when song.name == 'Misty' puts 'Not again!' when song.duration > 120 puts 'Too long!' when Time.now.hour > 21 puts "It's too late" else song.play end case when song.name == 'Misty' puts 'Not again!' when song.duraton > 120 puts 'Too long!' when Time.now > 21 puts "It's too late" else song.play end
當賦值一個條件表達式的結果給一個變量時，保持分支的縮排在同一層。
# bad - pretty convoluted kind = case year when 1850..1889 then 'Blues' when 1890..1909 then 'Ragtime' when 1910..1929 then 'New Orleans Jazz' when 1930..1939 then 'Swing' when 1940..1950 then 'Bebop' else 'Jazz' end result = if some_cond calc_something else calc_something_else end # good - it's apparent what's going on kind = case year when 1850..1889 then 'Blues' when 1890..1909 then 'Ragtime' when 1910..1929 then 'New Orleans Jazz' when 1930..1939 then 'Swing' when 1940..1950 then 'Bebop' else 'Jazz' end result = if some_cond calc_something else calc_something_else end # good (and a bit more width efficient) kind = case year when 1850..1889 then 'Blues' when 1890..1909 then 'Ragtime' when 1910..1929 then 'New Orleans Jazz' when 1930..1939 then 'Swing' when 1940..1950 then 'Bebop' else 'Jazz' end result = if some_cond calc_something else calc_something_else end
在方法定義之間使用空行并且一個方法根據邏輯段來隔開。
def some_method data = initialize(options) data.manipulate! data.result end def some_methods result end
避免在一個方法調用的最后一個參數有逗號，特別是當參數不在另外一行。
# bad - easier to move/add/remove parameters, but still not preferred some_method( size, count, color, ) # bad some_method(size, count, color, ) # good some_method(size, count, color)
當給方法的參數賦默認值時，在 = 兩邊使用空格：
# bad def some_method(arg1=:default, arg2=nil, arg3=[]) # do something... end # good def some_method(arg1 = :default, arg2 = nil, arg3 = []) # do something... end
雖然幾本 Ruby 書建議用第一個風格，不過第二個風格在實踐中更為常見（并可爭議地可讀性更高一點）。
避免在不需要的時候使用行繼續符 / 。實踐中，
除非用于連接字符串, 否則避免在任何情況下使用行繼續符。
# bad result = 1 - / 2 # good (but still ugly as hell) result = 1 / - 2 long_string = 'First part of the long string' / ' and second part of the long string'
采用連貫的多行方法鏈式風格。在 Ruby 社區有兩種受歡迎的風格，它們都被認為很好
- . 開頭(選項 A) 和 尾隨 . (選項 B) 。
(選項 A) 當一個鏈式方法調用需要在另一行繼續時，將 . 放在第二行。
# bad - need to consult first line to understand second line one.two.three. four # good - it's immediately clear what's going on the second line one.two.three .four
(選項 B) 當在另一行繼續一個鏈式方法調用，將 . 放在第一行來識別要繼續的表達式。
# bad - need to read ahead to the second line to know that the chain continues one.two.three .four # good - it's immediately clear that the expression continues beyond the first line one.two.three. four
在這里可以發現有關這兩個另類風格的優點的討論。
如果一個方法調用的跨度超過了一行，對齊它們的參數。當參數對齊因為行寬限制而不合適，
在第一行之后單縮進也是可以接受的。
# starting point (line is too long) def send_mail(source) Mailer.deliver(to: '[email protected]', from: '[email protected]', subject: 'Important message', body: source.text) end # bad (double indent) def send_mail(source) Mailer.deliver( to: '[email protected]', from: '[email protected]', subject: 'Important message', body: source.text) end # good def send_mail(source) Mailer.deliver(to: '[email protected]', from: '[email protected]', subject: 'Important message', body: source.text) end # good (normal indent) def send_mail(source) Mailer.deliver( to: '[email protected]', from: '[email protected]', subject: 'Important message', body: source.text ) end
對齊多行跨度的 array literals 的元素。
# bad - single indent menu_item = ['Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Baked beans', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam'] # good menu_item = [ 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Baked beans', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam' ] # good menu_item = ['Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam', 'Baked beans', 'Spam', 'Spam', 'Spam', 'Spam', 'Spam']
大數值添加下劃線來提高它們的可讀性。
# bad - how many 0s are there? num = 1000000 # good - much easier to parse for the human brain num = 1_000_000
使用 RDoc 以及它的慣例來撰寫 API 文檔。注解區塊及 def 不要用空行隔開。
每一行限制在 80 個字符內。
避免行尾空格。
不要使用區塊注釋。它們不能由空白引導（=begin 必須頂頭開始），并且不如普通注釋容易辨認。
# bad == begin comment line another comment line == end # good # comment line # another comment line
在 API 文檔中使用 RDoc和它的公約。不要在注釋代碼塊和def之間加入空行。
保持每一行少于80字符。
避免尾隨空格。
新聞熱點
疑難解答
圖片精選
