二、代碼排版規(guī)范
2.1 注釋風(fēng)格
注釋的位置應(yīng)與被描述的代碼相鄰,可以放在代碼的上方或右方,不要放在代碼的下方;注釋內(nèi)容應(yīng)明確表達(dá)被注釋代碼的含義。
例:
# Return a Watir::IE object for an existing IE window. Window can be
# referenced by url, title, or window handle.
# Second argument can be either a string or a regular expression in the
# case of of :url or :title.
# IE.attach(:url, 'http://www.google.com')
# IE.attach(:title, 'Google')
# IE.attach(:hwnd, 528140)
# This method will not work when
# Watir/Ruby is run under a service (instead of a user).
defself.attach(how, what)
ie = new true # don't create window
ie._attach_init(how, what)
ie
end
2.2 代碼格式
2.2.1代碼空格
逗號(hào)“,”、分號(hào)“;”之后要留空格
賦值操作符、比較操作符、算術(shù)操作符、邏輯操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”等二元操作符的前后都加空格或者前后都不加空格。
正例:
a+b
a + b
誤例:
a+ b
a +b
一元操作符如“!”、“~”以及“[]”、“.”、“::”這類操作符前后不加空格。
函數(shù)名之后不要留空格
2.2.2代碼縮進(jìn)
為了增加程序的可讀性而進(jìn)行的適當(dāng)?shù)目s進(jìn),縮進(jìn)的幅度以2個(gè)字符為宜。另外,縮進(jìn)的時(shí)候,只可使用空格,不可使用TAB(編程工具不同的時(shí)候,看起來會(huì)不一樣)
例:
if x > 0
if y > 0
puts "x > 0 && y > 0"
end
end
2.2.3空行
同一函數(shù)內(nèi),不同含義的代碼段之間空一行;不同函數(shù)和不同類之間空兩行
2.3.輸出檢查點(diǎn)的格式
輸出檢查點(diǎn)采用“---輸出語句---”格式,輸出語句應(yīng)簡潔清晰的表達(dá)意思。