小学生から始めるプログラミング:シェルスクリプトでコメントを書く

Raspberry Pi(ラズベリーパイ)でプログラミングに取り組んでいる小学生の方々の中には、本格的にコードを書いて勉強されている方もいるでしょう。

コードを書く時に、コメントを入れながら書くことは、いうまでもなく大変重要です。

シェルスクリプトの場合について、コメントを書く方法を書きます。

"#"を使って1行だけコメントを書く

シェルスクリプトでコメントを入れる方法は2つあります。

その１つが、コメントの先頭に"#"の記号を入れることです。

#!/bin/sh
#
# １から10まで加算して、結果を出力するプログラム
#

# 変数の初期化
M=10     # 1からMまで加算する
X=0      # 加算結果をX格納していく
INDEX=0  # ループのインデックス

# 加算の開始
while [ $INDEX -le $M ];do
  X=`expr $X + $INDEX`    # XにINDEXの値を加算してXに格納
  INDEX=`expr $INDEX + 1` # INDEXの値を1だけ加算
done

# 結果の出力
echo "結果: $X"

#!/bin/sh

# １から10まで加算して、結果を出力するプログラム

# 変数の初期化

M=10 # 1からMまで加算する

X=0 # 加算結果をX格納していく

INDEX=0 # ループのインデックス

# 加算の開始

while [ $INDEX -le $M ];do

X=`expr $X + $INDEX` # XにINDEXの値を加算してXに格納

INDEX=`expr $INDEX + 1` # INDEXの値を1だけ加算

done

# 結果の出力

echo "結果: $X"

ちょっとしつこいくらいにコメントを入れてみましたが、ポイントは2つあります。

まず1つ目。コメントを入れるときには、多くの場合、3行目や6行目のように、行頭に"#"記号を書いておきます。これで、#記号以下はコメントになり、プログラムとしては実行されません。

2行目や4行目のように、"#"以降になにも書かなくてもOKです。

ただし、このプログラムの1行目だけは特別です。これはコメントではありません。
このスクリプトをshというプログラムにかけて実行するためのおまじないです。
シェルスクリプト特有の事情と覚えてください。

２つ目は、によるコメントは、行の途中からでもよいということです。7行目などのように、行の途中で"#"を書いてもよく、この場合はこの#以降がコメントになります。

#より左の部分はプログラムとして実行されます。

"<<"(ヒアドキュメント)を使って、複数行のコメントを書く

もう1つの方法は、ヒアドキュメントを利用して、複数行をまとめてコメントにしてしまう方法です。

#!/bin/sh

echo "Line 1"
echo "Line 2"

<< COMMENT
echo "Line 3"
echo "Line 4"
echo "Line 5"
COMMENT

echo "Line 6"
echo "Line 7"

#!/bin/sh

echo "Line 1"

echo "Line 2"

<< COMMENT

echo "Line 3"

echo "Line 4"

echo "Line 5"

COMMENT

echo "Line 6"

echo "Line 7"

このプログラムでは、6行目から10行目までがコメントです。

"<<" という記号のあと、"COMMENT"という文字列を書いています。この文字列を書いた次の行から、10行目のようにもう一度"COMMENT"と書いた行までがコメントになります。

ヒアドキュメントという機能をコメントとして使用した書き方です。

"COMMENT"という文字列は、実はなんでもよいです。"AAA"でも構いません。自分でわかりやすい文字列に決めます。

この複数行のコメントの書き方、コメントとしてと書き残すというよりも、どちらかというとデバッグに使用することの方が多いかもしれません。

#!/bin/sh

X=0

<< COMMENT
if [ $X -eq 0 ];then
  echo "X = 0"
else
  echo "X != 0"
fi
COMMENT

echo "End"

#!/bin/sh

X=0

<< COMMENT

if [ $X -eq 0 ];then

echo "X = 0"

else

echo "X != 0"

COMMENT

echo "End"

一時的にコメント行にしておき、プログラムとして実行しないようにしておいて、テスト実行するといった使い方です。

どこにプログラムの問題(バグ)があるのか、探すときにも使ったりします。

自分でいろいろ書いて、試してみましょう。

コメントを残す理由

プログラミングして出来上がったプログラムには、なるべくコメントを残しておきましょう。

コメントを残すと、あとでいろいろ役に立ちます。

長いプログラムを書いているときにも見やすくなる。
他人がそのプログラムを読んでも、内容が理解できる。
自分が半年先、1年先に読んでも、内容が理解できる。

シンプルな内容のプログラムを数行程度書いている間はよいのですが、だんだん長いプログラムを書くようになると、自分でもどういうことを書いているのかわからなくなることがあります。

他人に見せるときは、なおさらですね。

さらに、これも大変重要なのですが、少し時間をおいてから自分の書いたプログラムを見た時、意外にもほとんどわからなくなっているということです。

半年先、1年先は、自分は別人になっていると思ったほうがよいでしょう。自分の書いたプログラムをそのくらい先に自分でみたとき、それは他人がみるのとほとんど同じくらいわからなくなっているものです。

ですので、なるべくコメントの機能を使って、どういう意図でそのプログラムを書いているのかをある程度細かく記しておくのがよいのです。

どれくらいの情報を書いておけばよいかは、たくさん書いてコツをつかむしかありませんが、とにかく自分で書いて練習してみましょう。