bashスクリプトでコメントを書く

Bashスクリプトを作成するときは、コードをクリーンでわかりやすくすることを常にお勧めします。 コードをブロックに整理し、インデントし、変数と関数にわかりやすい名前を付けることは、これを行うためのいくつかの方法です。

コードの可読性を向上させる別の方法は、コメントを使用することです。 コメントは、シェルスクリプトで記述された人間が読める説明または注釈です。

Bashスクリプトにコメントを追加すると、将来コードを見るときに時間と労力を大幅に節約できます。 数ヶ月または数年前に書いたスクリプトを変更したいとしましょう。 コメントを追加しない限り、複雑なコードを書いた理由を思い出せない可能性があります。

このコメントは、コードとその目的を理解するためにスクリプトを保守する必要がある他の開発者やシステム管理者にも役立ちます。

コメントは通常、コードができないことを説明するために使用されます。 たとえば、Bashスクリプト内に複雑な正規表現またはパラメーターの置換がある場合、コードの動作に関するコメントを記述する必要があります。 コメントは短く、要点を示す必要があります。 読者にとって単純で明白な何かを説明しないでください。

、Bashでコメントを書く際の基本について説明します。

Bashでコメントを書く

Bashは、行のハッシュマーク（ # ）の後に書き込まれるすべてを無視します。 このルールの唯一の例外は、スクリプトの最初の行が #! 始まる場合 #! 文字。 この一連の文字はShebangと呼ばれ、ファイルの残りの解析に使用するインタープリターをオペレーティングシステムに伝えるために使用されます。

コメントは、行の先頭または他のコードとインラインで追加できます。

# This is a Bash comment. echo "This is Code" # This is an inline Bash comment.

ハッシュマークの後の空白は必須ではありませんが、コメントの読みやすさが向上します。

通常、スクリプトをテキストエディターで開くと、コメントは緑色で表示されます。

コメントは、スクリプトをテストするときにも役立ちます。 いくつかの行またはブロックを削除する代わりに、コメントアウトできます：

# if]; then # echo "Variable is greater than 10." # fi

Bashの複数行コメント

ほとんどのプログラミング言語とは異なり、Bashは複数行コメントをサポートしていません。

Bashで複数行のコメントを記述する最も簡単な方法は、単一のコメントを次々に追加することです。

# This is the first line. # This is the second line.

もう1つのオプションは、HereDocを使用することです。 これは、複数行の入力をコマンドに渡すことができるリダイレクトの一種です。 HereDocブロックがコマンドにリダイレクトされない場合、複数行コメントプレースホルダーとして機能します。

<< 'MULTILINE-COMMENT' Everything inside the HereDoc body is a multiline comment MULTILINE-COMMENT

HereDocの使用はハックであり、複数行のBashコメントを記述するための実際の組み込み方法ではありません。 問題を回避するには、単一行のコメントを使用することをお勧めします。

結論

コメントを書くことは良い習慣であり、将来の自己を含む他の開発者がシェルスクリプトを理解するのに役立ちます。 Bashでは、ハッシュマーク（ # ）の後から行末までのすべてがコメントと見なされます。

ご質問やフィードバックがある場合は、お気軽にコメントをお寄せください。

バッシュターミナル