linux-video project

2002/5/1


■コーディング規約
  ・Ruby部分のソースコーディング規約
     Rubyの命名規約に従いましょう。
      次のものはRubyで決まっています。
       ・クラス名は先頭大文字
       ・ローカル変数は小文字or_で始まる
       ・グローバル変数は$で始まる
       ・インスタンス変数は@で始まる


    ローカルの規約
      ・indent は 2
          TAB は利用しても良い(TAB size 2)
          最終的には Space展開を考える
       
      ・ifやunless は、条件の後に then を付ける
        end は if と同じ高さにする。

        例
        if xxx then
        end

        unless xxx then
        end

      ・イテレータなどその他のブロックは次のようになる。
        イテレータなどで渡される。

        例
        array.each do |item|
        end

      ・関数のパラメータは a で始める
        次の表現にマッチする変数は、関数のパラメータだと思ってよい
            a[A-Z][a-zA-Z0-9]*

        例
        def create( aFilename , aMode )
        end

      ・関数名,変数名は小文字で始まる。
        また、複合語の場合には連接する単語の第一文字をupcaseして
        単につなげる

        例
         filenameList         #ファイルリスト(変数名)
         sortedFilenameList   #ソートされたファイルリスト(変数名)
         createFrom           #関数名

        変数名 は 名詞であることが望まれる
        関数名 は 動詞であることが望まれる

      ・クラス名、モジュール名
        大文字から始まる。
        また、複合語の場合には連接する単語の第一文字をupcaseして
        単につなげる

        例
        class Book
        class BookEntry

      ・全てのインスタンス変数を必ず initialize の中で初期化する
        (可能であれば、インスタンス変数定義時に
         コメントで何を参照するか示す。)

      ・基本的に日本語厳禁(^^;
        コメント部に日本語を書くときには、
        できるだけ英語コメントもつける。
        (出来れば英語コメント)

        クラス名、変数名、関数名は英語

      ・ソースコードに対するコメント
        必要ならば付ける
        (非常に多くコメントが必要な場合、リファクタリングを考慮する)


■ファイル名の命名規約

     ・クラスライブラリ・フレームワークなどのファイル名:
        1. 単語の場合は
            xxx.rb  (xxx ;= 単語)
        2. 複数語の場合は
            xxx_xxx.rb

     ・コマンドなどのファイル名:
        1. 単語の場合は(限りなく単語にできるように)
            xxx.rb  (xxx ;= 単語,略語)
        2. 複数語の場合は
            xxxXxx.rb

     ・ディレクトリ名
        1. 単語の場合は(限りなく単語にできるように)
            xxx/  (xxx ;= 単語,略語)
        2. 複数語の場合は
            xxx_xxx/

      ・設定ファイル
        1. 原則として初期設定から変更がないもの
           xxx.conf
           xxx_xxx.conf
           例外: 録画品質定義ファイル XxxxQ.conf (eg, NormalQ.conf)
        2. 日々変化するもの
           xxx
           xxx_xxx


■ cvs commit 時のログ
      必ず英語
      先頭に * はつけない。
      2つ以上の内容の場合は、; で区切る

