Bash スクリプトでコメントを追加する方法

1. Bash での一行コメント
2. Bash での複数行コメント

コメントはインタープリタが無視する行で、コードの中で何が起こっているかを説明したり、特定のブロックやコードの行が何をしているかについての洞察を与えるために使われます。コメントは、コードを読む人にとってコードを理解しやすくします。私たちは、コメントを使ってコードで何が起こっているかを人間の言葉で説明することができます。また、コードを書いてしばらくしてからコードを見直すときにも役立ちます。また、コメントはコードをデバッグするときにも役立ちます。バグが疑われる部分を削除するのではなく、特定の部分をコメントアウトしてデバッグすることができます。

Bash では # と heredoc を使ってコメントを書くことができます。一般的に、# は一行コメントを書くのに用いられ、heredoc は複数行コメントを書くのに用いられます。

Bash での一行コメント

Bash で 1 行のコマンドを書くには # 記号を使用します。# の後、スクリプトを解釈している間、 #!を含む最初の行以外はすべて無視されます。最初の行に表示されるこの特定のシーケンス #!は Shebang と呼ばれ、使用するインタープリターを決定するために使用されます。

コメントは行頭から始めてもよいし、コードのインラインであってもよい。

#!/bin/bash
echo "Hello World!" # echo is similar to print statement.
# end of the code

出力：

Hello World!

ここでは、最初の行で使用するコンパイラが /bin/bash であることを示しています。

2 行目にはインラインコメントがあり、3 行目には行頭から始まるコメントがあります。

Bash での複数行コメント

Bash は複数行コメントをサポートしていません。Bash で複数行コメントを書く方法の一つは、各行に一行コメントを使用することです。

# This is a
# multiline comment in Bash
echo "Hello World!"

出力：

Hello World!

ここでは、1 行目と 2 行目を複数行コメントとみなすことができ、各行はインタプリタによって別々のコメントとして解釈されます。

また、Heredoc を利用して複数行のコマンドを書くこともできます。Heredoc は複数行の入力をコマンドに渡す方法です。Heredoc がどのコマンドにもリダイレクトされていなければ、Heredoc を複数行のコメントとして使うことができます。

#!/bin/bash

<< 'Comment'
    Everything inside the
    HereDoc body is
    a multiline comment
Comment
echo "Hello World!" 

出力：

Hello World!

ここでは、3 行目から 7 行目までを複数行のコメントとみなす。