Rubyコーディング規約
BRANK

はじめに本文書は、Rubyによりコーディングを行う際の規約について述べる。 実際のプロジェクトに適用する際には、このコーディング規約をカスタ マイズして用いることを推奨する。ソースコードの整形インデントプログラムを読みやすくするため、インデントを適宜行う。インデント 幅は2とする。また、インデントにはスペースのみを使用し、タブは使用 しない。(環境によりタブ幅が異なるため。)例: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コメントメソッド定義の中にはコメントは記述しない。(コメントが必要だと思わ れるようなコードにはリファクタリングを行う…

shugo.net
Related Topics: Ruby