二、代码排版规范
2.1 注释风格
注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不要放在代码的下方;注释内容应明确表达被注释代码的含义。
例:
# 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代码空格
逗号“,”、分号“;”之后要留空格
赋值操作符、比较操作符、算术操作符、逻辑操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”等二元操作符的前后都加空格或者前后都不加空格。
正例:
a+b
a + b
误例:
a+ b
a +b
一元操作符如“!”、“~”以及“[]”、“.”、“::”这类操作符前后不加空格。
函数名之后不要留空格
2.2.2代码缩进
为了增加程序的可读性而进行的适当的缩进,缩进的幅度以2个字符为宜。另外,缩进的时候,只可使用空格,不可使用TAB(编程工具不同的时候,看起来会不一样)
例:
if x > 0
if y > 0
puts "x > 0 && y > 0"
end
end
2.2.3空行
同一函数内,不同含义的代码段之间空一行;不同函数和不同类之间空两行
2.3.输出检查点的格式
输出检查点采用“---输出语句---”格式,输出语句应简洁清晰的表达意思。