コーディングスタイル
スクリプトと言うのは、作業を楽にする為に書く物です。
1回だけ使って、そのまま放置するようなスクリプトは出来る限り書くべきではありません。
また同じスクリプトを書く羽目になる事が多いからです。
1回必要になる物は、何回も必要になる、そういう物です。
せっかく楽をする為にスクリプトを書いているのに、何度も同じスクリプトを書いているのでは、
本当の意味で楽にはなっていないはずです。
とは言っても、スクリプトの書き捨てというのは結構あるものです。
なぜこうなるのでしょうか?
それは「後から見ると、何が書いてあるのか理解できない」からです。
簡単に書ける物だからこそ、理解できない物を使うよりは、新しく書いてしまった方が早いのです。
この「後から見ると理解できない」という事象は、多かれ少なかれ、スクリプトを書いた事のある人で
あれば経験した事はあると思います。これを極力なくす為にはどうすればいいのか?
まず「コメントを付ける事」です。
どんな簡単な処理でも、簡単なコメントを付ける様にした方がいいです。
ただ、1行ごとにコメントをつけると、スクリプト自体の可読性が落ちますので、それは避けましょう。
処理のブロック毎に複数行のコメントをつけると、後から読んでも割と判りやすい物になると思います。
次に「書式を統一する事」です。
これによって、スクリプトの可読性は全然違ってきます。
コーディングスタイルは人により好みが判れるところだと思いますが、私は以下の様なポリシーで
記述する事にしています。
・1行には(できる限り)1つの命令
・字下げはオールマンスタイル踏襲
・変数は全て大文字、関数名は単語頭文字のみ大文字
・変数名、関数名、配列名等は、種類判別が出来る接頭文字をつける
以下、記述例です
●変数名(頭に「V_」をつける)、配列名(頭に「A_」をつける)例
V_AAA="変数" A_BBB[1]="配列要素"
●関数名(頭に「F_」をつける
function F_TestFunction
{
処理を記述
}
●while文例
while 継続条件を記述 do 処理を記述 done
●if文例
if 判定を記述 then 処理を記述 elif 判定を記述 then 処理を記述 else 処理を記述 fi
●「|(パイプ)」処理時の記述例
ps -ef | \ grep -v "grep" | \ sort | \ uniq | \ wc -l
この講座では、上記書式に基づいて記述したいと思います。
「コメントをつける」と「書式を統一する」という、この2つのルールを守れば、
後日、同じ様な処理をしたい時に、スクリプトを確認するのが格段に楽になります。
変数名や関数名などの命名規則もある程度は決めた方がいいのですが、
パッと見て何が格納される物なのかがわかる程度であれば、厳密に決める必要は
無いと思います。ただ、接頭文字については、検索のしやすさ等考えると、必ずつけた方が
いいでしょう。
- 参照(798)
