RubyNamingRule(CN).docVIP

Ruby编程规约 前言 本规约、Ruby进行编程时所使用的编程规约。 源代码的整形 代码缩进 为了增加程序的可读性而进行的适当的缩进，缩进的幅度以2个字符为宜。另外，缩进的时候，只可使用空格，不可使用TAB（编程工具不同的时候，看起来会不一样） 例: if x 0 if y 0 puts x 0 y 0 end end 一行的字符数以80字符（半角）为宜。 空行 例: class Foo ... end class Bar ... end 误例: class Foo ... end class Bar ... end 另外、类中的各个构成要素之间也需要用空行来隔开。但是，最初的要素之前和最后的要素之后不需要插入空行。 正例: class Foo attr :bar def baz ... end def quux .. end end 误例: class Foo attr :bar def baz ... end def quux ... end end 方法的定义中不需要注释行。() 但是，对类、模块、或公有方法的说明，要使用RDoc的风格来描述。 例: #分割用逗号区分的字符串，把结果返回给数组。 def split_csv(str) return str.split(/,/) end 程序结构相关的规约 类的构成要素 类的构成要素以下记的顺序来记述。 模块的包含 常数的定义 类变量、类实例变量的定义 公有类方法的定义 accessor的定义 initialize的定义 公有实例方法的定义 保护类方法的定义 保护accessor的定义 保护实例方法的定义 私有类方法的定义 私有accessor的定义 私有实例方法的定义 嵌套类的定义 accessor的定义 在accessor的定义中，使用attr_accessor、attr_reader、 attr_writer (不使用attr) 方法的定义 方法的定义中，形参要用括号括起来。但是、例: def foo(x, y) ... end def foo ... end 误例: def foo x, y ... end def foo() ... end 类方法的定义的时候要使用self。 例: class Foo def self.foo ... end end 误例: class Foo def Foo.foo ... end end 方法调用 调用某个方法的时候，参数要用括号括起来。print、puts、p的时候，也可已省略参数。 正例: foo(1, abc) obj.foo(1, abc) bar print x = , x, \n 误例: foo 1, abc obj.foo 1, abc bar() 代码块 一个代码块基本上使用do ... end来包括起来 正例: foo(x, y) do ... end x = 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 + y end 误例: def add(x, y) x + y end def add(x, y) return(x + y) end yield yield的调用方法遵照方法的调用规则。 If语句的then可以省略。另外、if !x的时候、 unless x来置换。但是，unless的时候、 else。还有，非常简单的条件，一行能够写下来的时候，也可使用if/while。 例: if x 0 puts x 0 else puts x = 0 end unless x puts x is false end puts x is true if x 误例: if x 0 then puts x 0 end unless x puts x is false else puts x is true end puts foo bar baz quux if