シェルスクリプトでコメントを入れたいけど入れ方がわからない。
また複数行コメントアウトできればやりたいといった要望はあると思います。
そこで今回はシェルスクリプトでのコメントアウトのやり方をエンジニアの筆者が教えます!
シェルスクリプトでコメントアウトのやり方
シェルスクリプトでのコメントアウトのやり方は以下です。
#を付ける事でコメントアウトする事が出来ます。
どこで使用できるかは以下の2つになります。
- 行全体をコメントアウトする
- 行の途中からコメントアウトする
シェルスクリプトで行全体をコメントアウトする方法
行の先頭に#を付ける事でその行はコメントアウトする事が出来ます。
#!/bin/bash
#コメントアウトになります。
シェルスクリプトで行の途中からコメントアウトする方法
行の途中でコメントアウトする事が出来ます。
#!/bin/bash
echo コメントアウトしています。 #ココはコメントです。
echoコマンドは文字を表示するコマンドです。
シェルスクリプトで行の途中からコメントアウトする時の注意点
しかし途中からコメントアウトする場合#の前に半角スペースが必要です。
それでは実際にシェルスクリプトを実行してみましょう!以下のファイルを作成してください。
#!/bin/bash
#コメントアウトしています。
echo 行の途中からコメントアウトしています。 #の前は半角スペースです。
echo 行の途中からコメントアウトしています。 #の前は全角スペースです。
echo 空白がない為コメントアウト出来ていません#ココはコメントの想定です。
このシェルスクリプトを実行します。「.」でシェルスクリプトを実行する事ができます。
結果は以下の通りとなりました。
1行目は全てコメントアウトされていますので、行全体が表示されていません。
2行目は行の途中からコメントアウトされています。
3,4行目はコメントアウトされていません。
業務で使用するコメントアウト術
シェルスクリプトでコメントアウトして説明を記述する事は良い事です。後で見た自分や他の人が分かりやすくなるため、コメントアウトでの説明は必須です。
また業務や開発などではコマンド自体をコメントアウトする事がよくあります。
テストで一部のコマンドは一時実行したくない場合に、コマンドの前に#を入れてコメントアウトしてテストします。コメントアウトも効率よく使用しましょう!
シェルスクリプトで複数行コメントアウト出来るか?
シェルスクリプトでは複数行コメントアウトする事はできません。
対応策としてはコメントアウトしたい行すべてに#をつけるしかありませんでした。
シェルスクリプトでコメントアウトのやり方!複数行も可能か?まとめ
シェルスクリプトでコメントアウトする方法は#を付ける事。
どこにつけれるかは2種類ありました。
- 行全体をコメントとする
- 行の途中からコメントにする
行全体に着ける場合は行の初めに#をつける
行の途中でコメントつけたい場合は半角スペースと#をいれる
シェルスクリプトで複数行コメントアウトは出来ないので、コメントしたい全ての行に#を入れる必要がある。