MOMONGA LAB島根オフィシャルBlog > 学習 > コメントのルール

コメントのルール

コメント以外に,基本的なコーディング規約は公式サイトからリンクされているRubyコーディング規約に準拠したい。ここに書いてあることについては記載されたとおりに従うものとし,それ以外は独自にルールを作っておきたい。

1. コメント

コメントについては以下のようにする。

1.1. require 宣言のコメント

最初は他の Ruby ソースをロードする require 宣言に記述するコメント。

このように定義する。ハイフンの個数は 80 個。Ruby の複数行コメントの =begin ~ =end を使用する。
なお, require については他の Ruby ソースをローディングする宣言1であるが,同一のフォルダ内に存在する Ruby ソースをロードするときに,

と書くと正常にロードできず,

と書かなければならなかった2

1.2. クラスのコメント

次はクラス宣言に記述するコメント。

基本的には require と同じ記述方式とする。ハイフンではなくアスタリスクを 80 桁使用する。

1.3. メソッドのコメント

最後はメソッドのコメント。

2. その他

番外編で,次のルールを決めておきたい。

Ruby ではクラス,メソッドの定義だけではなく,if 文や for 文でもそのブロックが終わるときに end を使用する。このとき,end が多重になってどの終わりがどのインデントになっているのか判断しづらくなるため,上記のように end に対応するコメントをつけておく。


  1. Java 言語でいうところの import に近い。C/C++ 言語だと #include と同じものだろう。 
  2. ここについては今後も調査が必要。 
タグ: , , , , ,