【15秒理解】Linuxシェルスクリプトでのコメントの書き方

このページではシェルスクリプトでのコメントの書き方をご紹介しよう。

Linuxではシェルスクリプトに限らず、設定ファイルなども基本的には「#」を先頭につければコメントアウトされる。

これだけOKかもしれないが、細いところもご紹介しておこう。

シェルスクリプトのコメントとは？

コメントとは？

シェルスクリプトでプログラミングを始めて体験するという方のために簡単にご説明しておく。

プログラミングには説明のための「コメント」を書いておくのが一般的だ。

コメントというのは、コンピュータが理解するためではなく「人間が理解するためのコード」と言える。コメントはソースコードをコンパイル時、もしくはインタプリタを通して実行するとき「無視」される。

実際コメントは一文字も書かなくても、コンピュータ側からするとまったく問題にならない。

なぜコメントを残すのか？

確かに自分の書いた数行のスクリプトなら、読みなおすのも苦ではないかもしれない、しかしこれが

• 数百行だったらどうだろうか？
• もしくは他人に開示するソースコードだったとしたら？

読み直すのは苦痛だ。

日本語で説明が書いてあるわけではなく、後から見たときに「何のために」「どんな」プログラムが書いてあるかわからないからだ。

この場合ソースコードを読みとくための手掛かりが必要だ。

そのためあらかじめソースコードの中にコメントという形でメッセージやドキュメントに類するものを残しておく必要がある。細々としたことでもいいのでコメントは積極的に残すようにしよう。

コメントの残し方に関してはベストプラクティスのようなものがあるが、まずはとりあえず積極的に残すようにしてみよう。

コメントアウト

こちらも一応ご紹介しておく。

コメントにしてソースコードを無効化することを「コメントアウト」ともいう。プログラムを修正するときにコード部分をコメントにしてしまい、動作させなくするわけだ。

デバッグと言って、バグを見つけるときなどによく利用される。言葉は覚えておこう。

実際にコメント入力

標準のBashシェルスクリプトの場合「#」から先が「コメント」として認識される。コメントはスクリプトとして実行するときは無視される。

実験的なコードを有効にしたり、無効化したり、スイッチとしても使用できる。

サンプル

実際にシェルスクリプトを見てみよう。

vi test-hello-world.sh

実行

$ chmod 755 test-hellow-world.sh

$ ./test-hellow-word.sh

「#print hello-my-world」のコメントを外してみる。

まとめ

このページではシェルスクリプトのコメントについてお伝えした。

結論的には行の先頭に「#」を書けばコメントになる。シェルスクプトに限らずLinuxの設定ファイルは全般「#」でコメントアウトになる。覚えておこう。