749

15. コーディングスタイル

750

この章では Live システムで利用されているコーディングスタイルについて述べます。

751

15.1 互換性

752

• Bash シェル固有の書式や記号を使わないでください。例えば配列構造の利用など

753

• POSIX のサブセットだけを使ってください - 例えば `foo` よりも $(foo) を使ってください。

754

• 'sh -n' と 'checkbashisms' によりスクリプトをチェックできます。

755

• シェルコードが全て確実に 'set -e' で動作するようにしてください。

756

15.2 インデント

757

• 常にスペースよりもタブを使います。

758

15.3 改行

759

• 通常、行は最大で80文字までです。

760

• 「Linux 式」で改行します:

761

悪い例:

762

if foo; then
         bar
fi

763

良い例:

764

if foo
then
         bar
fi

765

• 関数についても同様です:

766

悪い例:

767

Foo () {
         bar
}

768

良い例:

769

Foo ()
{
         bar
}

770

15.4 変数

771

• 変数は常に大文字です。

772

• live-build で利用する変数は先頭を常に LB_ で始めます。

773

• live-build 内部の一時変数は _LB_ で始めます。

774

• live-build のローカル変数は __LB_ で始めます。

775

• live-config 中のブートパラメータにつながる変数は LIVE_ で始めます。

776

• live-config 中の他の変数は全て _ で始めます。

777

• 変数は大括弧「{}」で囲みます。例えば $FOO ではなく ${FOO} とします。

778

• 空白文字の可能性を考慮し、常に引用符を使って変数を保護します: ${FOO} ではなく "${FOO}" とします。

779

• 一貫性を保つため、変数に値を割り当てるときは常に引用符を使います:

780

悪い例:

781

FOO=bar

782

良い例:

783

FOO="bar"

784

• 複数の変数を使うときは表現全体を引用符で囲みます:

785

悪い例:

786

if [ -f "${FOO}"/foo/"${BAR}"/bar ]
then
         foobar
fi

787

良い例:

788

if [ -f "${FOO}/foo/${BAR}/bar" ]
then
         foobar
fi

789

15.5 その他

790

• sed を呼び出すときは区切り文字に「|」を使います。例えば「sed -e 's|foo|bar|'」

791

• 比較やテストには test コマンドを使わず、「[」や「]」を使います。例えば「if [ -x /bin/foo ]; ...」を使い、「if test -x /bin/foo; ...」は使いません。

792

• test よりも case の方が読みやすく実行速度も早いため、可能な部分ではこちらを使います。

793

• ユーザの環境と混ざる可能性を限定するため、関数の名前には大文字を使います。