Ruby语言规范

Ruby编程规约前言本规约、记述的是在用Ruby进行编程时所使用的编程规约。

在实际项目开发的时候，推荐以此为基础，根据项目实际情况进行客户化后再使用。

源代码的整形Array代码缩进为了增加程序的可读性而进行的适当的缩进，缩进的幅度以2个字符为宜。

另外，缩进的时候，只可使用空格，不可使用TAB（编程工具不同的时候，看起来会不一样）例:if x>0if y>0puts"x>0&&y>0"endend一行的字符数一行的字符数以80字符（半角）为宜。

空行用空行来区分开复数的类正例:class Foo...endclass Bar...end误例:class Foo...endclass Bar...end另外、类中的各个构成要素之间也需要用空行来隔开。

但是，最初的要素之前和最后的要素之后不需要插入空行。

正例:class Fooattr:bardef baz...enddef quux..endend误例:class Fooattr:bardef baz...enddef quux...end Array end注释方法的定义中不需要注释行。

(但是，对类、模块、或公有方法的注释要使用RDoc的风格来注释。

例:#コンマ区切の文字列+str+を分割し、結果を配列にして返す。

def split_csv(str)return str.split(/,/)end程序结构相关的规约类的构成要素类的构成要素以下记的顺序来记述。

1.模块的包含2.常数的定义3.类变量、类实例的定义4.公有方法的定义5.控制符的定义6.initialize的定义7.公有实例方法的定义8.保护类方法的定义9.保护控制符的定义10.保护实例方法的定义11.私有类方法的定义12.私有控制符的定义13.私有实例方法的定义14.嵌套类的定义控制符的定义在控制符的定义中，使用attr_accessor、attr_reader、attr_writer(不使用attr)方法的定义方法的定义中，形参要用括号括起来。

但是、没有参数的时候，括号可以省略。

正例:def foo(x,y)...enddef foo...end误例:def foo x,y...enddef foo()...end类方法的定义类方法的定义的时候要使用self。

正例:class Foodef self.foo...endend误例:class Foodef Foo.foo...endend方法调用调用某个方法的时候，参数要用括号括起来。

但是，没有参数的时候，括号可以省略。

另外，print、puts、p的时候，也可已省略参数。

正例:foo(1,"abc")obj.foo(1,"abc")barprint"x=",x,"\n"误例:foo1,"abc"obj.foo1,"abc"bar()代码块一个代码块基本上使用do...end来包括起来正例:foo(x,y)do...endx=bar(y,z)do...end误例:foo(x,y){...}x=bar(y,z){...}但是，方法链使用的时候，用{...}来包括起来。

正例:s=ary.collect{|i|i.to_s}.join(",")误例:s=ary.collect do|i|i.to_s end.join(",")return方法有返回值的时候、必须使用return来明示。

另外、return的括号可以省略。

例:def add(x,y)return x+yend误例:def add(x,y)x+yenddef add(x,y)return(x+y)endyieldyield的调用方法遵照方法的调用规则。

条件分支If语句的then可以省略。

另外、如果是if!x的时候、请用unless x来置换。

但是，unless的时候、不使用else。

还有，非常简单的条件，一行能够写下来的时候，直接使用if/while也可。

正例:if x>0puts"x>0"elseputs"x<=0"endunless xputs"x is false"endputs"x is true"if x误例:if x>0thenputs"x>0"endunless xputs"x is false"elseputs"x is true"endputs"foo&&bar&&baz&&quux"if foo&& bar&&baz&&quux能使用case、请使用case。

省略掉then。

正例:case xwhen1...when2...end误例:if x==1...elsif x==2...endcase xwhen1then...when2then...end不要直接使用条件分支作为代入值。

正例:if x>0msg="x>0"elsemsg="x<=0"end误例:msg=if x>0"x>0"else"x<=0"end循环While语句do省略。

另外、while!x的时候、请使用until x。

正例:while cond...enduntil cond...end误例:while cond do...end另外、无限循环的时候，使用loop。

正例:loop do...end误例:while true...end逻辑运算符逻辑运算中，使用!、&&、||。

(not/and/or不使用。

)三项运算符除非有明确的可读性，尽量不要使用三项运算符。

特别是、括号等必要的条件复杂的时候、跨行的时候、不使用三项运算符。

字符串字符串基本上使用"..."的形式。

但是，只有在某些特殊文字的场合，使用'...'的形式。

另外、原则上不使用“here document”命名规约全体1.原则上、不建议使用省略的单词。

2.作用域小的变量、i,j,k等单字母，顺序使用。

3.作用域小的变量、使用类名的省略语也没有关系。

(例:eo=ExampleObject.new)类名和模块名类以及模块名、每个单词的头一个字母大写、不要使用’_’（下划线）等分隔符。

但是、像HTTP这样的通用缩略语，全体大写也可。

正例:ExampleClassHTTPClient误例:Example_ClassEXAMPLE_CLASSHttpClientHTTPclientHTTP_Client方法名方法名は、全部小写、各个单词之间用’_’分隔。

方法名中请使用动词的原形。

正例:add_something误例:addsSomethingAdd_Something返回真假值的方法的命名、在动词或形容词后追加’?’、形容词的时候，不用添加’is_’。

正例:visible?误例:is_visibleis_visible?另外、破坏性和非破坏性的方法都提供的时候、在破坏性的方法名后追加’!’。

例:splitsplit!#具有破坏性的split常数名类・模块名以外的常数名、全部用大写、单词之间用’_’来分隔。

例:EXAMPLE_CONSTANT变量名变量名中、全部用小写、单词之间用’_’来分隔。

例:tmplocal_variable@instance_variable$global_variable文件名在文件名中、全部使用小写字母、单词之间用’_’来分隔。

另外、可以把文件中主要的类名变成小写后作为文件名来使用。

(把模块作为命名空间来使用的时候，同时使用目录名，可以体现出构造的阶层来。

)例:foo.rb#定义了类Foofoo-bar.rb#定义了类FooBarfoo/bar-baz.rb#定义了类Foo::BarBazCopyright(C)2007Shugo Maedalicensed under Creative Commons Attribution License。