コメントアウトとは、プログラムの一部を一時的に動かさないようにする書き方のことです。
プログラムとは、コンピューターにしてほしい作業を順番に書いたものです。コードとは、その命令を書いた文字のことです。
かんたんに言うと、コメントアウトは「この部分はいったん使わない」とコンピューターに伝える方法です。コードを消さずに残せるため、あとで元に戻したいときにも役立ちます。
この記事では、コメントアウトの意味、使う場面、HTMLやPythonでの書き方、複数行のコメントアウト、VSCodeのショートカットまで初心者向けに解説します。
関連するIT用語をまとめて確認したい方は、IT用語一覧もあわせてご覧ください。
コメントアウトとは？かんたんに言うと「コードを一時的に止めること」
コメントアウトとは、コードを一時的に動かさないようにすることです。
ここでいう「動かす」とは、コンピューターが命令どおりに処理することです。これをITでは「実行する」といいます。
コメントアウトすると、コード自体は残ります。しかし、コンピューターはその部分を命令としては使いません。
コメントアウトの意味
コメントアウトは、英語の「comment out」から来た言葉です。
「コメント」は、コードの中に書く説明やメモのことです。「アウト」は、実行の対象から外すという意味で使われています。
つまりコメントアウトとは、コードをコメントのように扱い、コンピューターが読み飛ばす状態にすることです。
身近な例でいうと「買い物メモに線を引く」ようなもの
身近な例でいうと、買い物メモの一部に線を引いて「今回は買わない」としておくようなものです。
メモから消してしまうと、あとで何を書いていたか分からなくなります。しかし、線を引いて残しておけば、必要になったときに見返せます。
ITでいうコメントアウトも同じです。コードを消さずに残したまま、いったん動かさないようにできます。
コメントアウトは何のために使う？
コメントアウトは、プログラムを作るときや直すときによく使われます。
主な目的は、コードを一時的に止めること、メモを残すこと、正しく動かない原因を調べることです。
一時的にコードを動かさないため
コードの一部を試しに止めたいとき、コメントアウトを使います。
たとえば、Webページの一部を一時的に表示しないようにしたい場合があります。そのようなときに、対象のコードをコメントアウトします。
コードを削除しないため、あとで簡単に戻せます。
あとで見返すためのメモを残すため
コメントアウトは、コードの説明を残すときにも使われます。
たとえば、「ここはあとで直す」「この処理は画面表示のため」などのメモを書けます。
未来の自分や、一緒に作業する人が内容を理解しやすくなります。
エラーの原因を探すため
エラーとは、プログラムが正しく動かない状態のことです。
エラーが出たときは、どこで問題が起きているかを調べる必要があります。そのときに、怪しい部分を一時的にコメントアウトして確認することがあります。
動きが変わるかを見ながら、原因を少しずつ探せます。
複数人で作業内容を共有するため
学校や仕事で複数人が同じコードを見る場合、コードの意図を伝えることが大切です。
コメントアウトで短い説明を入れておくと、ほかの人が見ても分かりやすくなります。
ただし、古いコメントや長すぎる説明が多いと、かえって読みにくくなることもあります。
コメントアウトの書き方
コメントアウトの書き方は、使う言語によって違います。
ここでいう言語とは、コンピューターに命令を書くための書き方のことです。HTML、CSS、JavaScript、Python、SQLなどがあります。
ここでは、初心者がよく見かけるものを中心に紹介します。
HTMLのコメントアウト
HTMLは、Webページの見出しや文章、画像などを置くための書き方です。
HTMLでは、次のようにコメントアウトします。
<!-- ここはコメントアウトです -->たとえば、Webページの一部を一時的に表示させたくないときに使います。
<!--
<p>この文章は一時的に表示しません。</p>
-->この中に入っているHTMLは、画面には表示されません。
ただし、HTMLのコメントアウトは、ページの見た目には表示されなくても、ソースには残ります。ソースとは、Webページの元になるコードのことです。
CSSのコメントアウト
CSSは、文字の色、余白、背景など、Webページの見た目を整えるための書き方です。
CSSでは、次のようにコメントアウトします。
/* ここはコメントアウトです */たとえば、文字の色を変える指定を一時的に止めたい場合は、次のように書けます。
/*
p {
color: red;
}
*/JavaScriptのコメントアウト
JavaScriptは、Webページに動きをつけるための書き方です。
1行だけコメントアウトするときは、次のように書きます。
// ここはコメントアウトです複数行をコメントアウトするときは、次のように書きます。
/*
ここから
ここまで
コメントアウトです
*/Pythonのコメントアウト
Pythonは「パイソン」と読みます。データ処理やAI、Webサービス作りなどで使われることが多い言語です。
Pythonでは、1行のコメントアウトに「#」を使います。
# ここはコメントアウトです
print("こんにちは")この場合、「#」が付いた行は実行されません。
Pythonで複数行を止めたいときも、各行の先頭に「#」を付ける方法がよく使われます。
# print("1行目")
# print("2行目")
# print("3行目")ほかの記事では、「”””」や「”’」で囲む方法を複数行コメントとして紹介していることがあります。
ただし、これは厳密にはコメントではなく、文字列として扱われます。関数やクラスの説明に使う「ドキュメント文字列」として使われることもあります。
初心者のうちは、複数行をコメントアウトしたいときも、基本は各行に「#」を付ける方法を使うと分かりやすいです。
SQLのコメントアウト
SQLは「エスキューエル」と読みます。データベースから情報を取り出したり、登録したりするための書き方です。
データベースとは、住所録や名簿のように、情報をまとめて保存しておく場所のことです。
SQLでは、1行のコメントアウトに「–」を使います。
-- ここはコメントアウトです
SELECT * FROM users;複数行をコメントアウトするときは、次のように書くことがあります。
/*
SELECT * FROM users;
SELECT * FROM orders;
*/
複数行をコメントアウトする方法
複数行のコメントアウトとは、2行以上のコードをまとめて動かさないようにすることです。
長いコードを一時的に止めたいときに便利です。ただし、書き方は言語によって違います。
HTMLで複数行をコメントアウトする方法
HTMLでは、「<!–」と「–>」で囲むと、複数行をコメントアウトできます。
<!--
<h2>見出し</h2>
<p>この文章は表示しません。</p>
-->この中に入っているHTMLは、画面には表示されません。
Pythonで複数行をコメントアウトする方法
Pythonでは、複数行をまとめて止めたい場合、各行の先頭に「#」を付ける方法が分かりやすいです。
# print("朝")
# print("昼")
# print("夜")「”””」や「”’」で囲む書き方を見かけることもありますが、これは本来コメントではありません。
Pythonでは、囲まれた内容が文字列として扱われます。書く場所によっては思わぬ動きになることもあるため、初心者のうちは「#」を使う方法がおすすめです。
VSCodeなどの編集ツールを使うと、複数行を選んでまとめてコメントアウトできます。
VBAで複数行をコメントアウトする方法
VBAは、Excelなどの作業を自動化するときに使われる言語です。
VBAでは、行の先頭に「’」を付けるとコメントアウトできます。
' MsgBox "こんにちは"
' MsgBox "テストです"ExcelのVBA画面では、ツールバーを使って複数行をまとめてコメントアウトすることもできます。
PowerShellで複数行をコメントアウトする方法
PowerShellは、Windowsで作業を自動化するときに使われる書き方です。
たとえば、ファイル操作や設定変更などをまとめて行うときに使われます。
1行だけコメントアウトするときは「#」を使います。
# ここはコメントアウトです複数行をコメントアウトするときは、次のように書けます。
<#
ここから
ここまで
コメントアウトです
#>VSCodeでコメントアウトするショートカット
VSCodeは、正式にはVisual Studio Codeといいます。コードを書くための無料の編集ツールです。
ショートカットキーとは、マウスを使わずに、キーボードだけで操作するためのキーの組み合わせです。
VSCodeでは、ショートカットキーを使うと、すばやくコメントアウトできます。
Windowsでコメントアウトするショートカット
Windowsでは、コメントアウトしたい行を選んで、次のキーを押します。
Ctrl + /もう一度同じキーを押すと、コメントアウトを解除できます。
Macでコメントアウトするショートカット
Macでは、コメントアウトしたい行を選んで、次のキーを押します。
Command + /Windowsと同じように、もう一度押すと解除できます。
コメントアウトを解除するショートカット
コメントアウトを解除するには、コメントアウトされた行を選び、同じショートカットキーを押します。
つまり、VSCodeでは「コメントアウトする」と「解除する」が同じ操作です。
コメントアウトとコメントの違い
コメントアウトとコメントは、似ていますが意味が少し違います。
どちらもコードの中に書かれますが、目的が違います。
コメントは「説明を書くこと」
コメントとは、コードの中に説明やメモを書くことです。
たとえば、「この行は合計金額を計算する」など、読む人に意味を伝えるために使います。
コメントアウトは「コードを動かさないようにすること」
コメントアウトとは、もともと動くコードを一時的に動かさないようにすることです。
説明を書くためのコメントとは違い、コードの動きを止める目的で使われます。
コメントアウトの反対は何？
コメントアウトの反対は、コメントアウトを外して、コードをもう一度動く状態に戻すことです。
英語では「アンコメント（uncomment）」と呼ばれることがあります。日本の現場では「コメントアウトを解除する」と言うことが多いです。
コメントアウトを外すことを「コメントイン」と呼ぶ場合がある
日本の一部の現場では、コメントアウトを外すことを「コメントイン」と呼ぶ場合があります。
ただし、一般的には「コメントアウトを解除する」と言えば伝わりやすいです。
実務では「コメントアウトを解除する」と言うことが多い
仕事や学習の場面では、「コメントインする」よりも「コメントアウトを解除する」と言うほうが分かりやすいです。
海外のツールや公式の説明では、「uncomment」という言葉が出てくることもあります。意味は「コメントアウトを外す」と考えれば大丈夫です。
初心者が間違えやすいコメントアウトの注意点
コメントアウトは便利ですが、使い方には注意点があります。
ここでは、初心者が特に間違えやすい点を紹介します。
HTMLのコメントアウトはソースに表示される
HTMLでコメントアウトした内容は、画面には表示されません。
しかし、Webページのソースを見ると、コメントアウトの中身が見えることがあります。
そのため、パスワード、個人情報、公開したくないメモは書かないようにしましょう。
JSONは基本的にコメントアウトできない
JSONは、アプリやWebサービスの設定を書くときによく使われる形式です。
通常のJSONでは、基本的にコメントアウトは使えません。
VSCodeの設定ファイルなど、一部の特殊なファイルではコメントを書ける場合があります。これは「JSONC」という、コメントを許した形式で扱われているためです。
しかし、一般的な「.json」ファイルにコメントを書くと、VSCodeでもエラーになることがあります。
そのため、JSONでは「コメントアウトできないことが多い」と覚えておくとよいでしょう。
コメントアウトを残しすぎるとコードが読みにくくなる
古いコードをたくさんコメントアウトしたまま残すと、どれが必要なコードなのか分かりにくくなります。
一時的に残すのは便利ですが、不要になったら整理することも大切です。
大事なコードをコメントアウトしたままにしない
確認用にコメントアウトしたコードを、元に戻し忘れることがあります。
動きがおかしいときは、必要なコードがコメントアウトされたままになっていないか確認しましょう。
コメントアウトに関するよくある質問
最後に、コメントアウトについてよくある質問をまとめます。
コメントアウトの記号は言語ごとに違う？
はい。コメントアウトの記号は、使う言語によって違います。
HTMLでは「<!– –>」、Pythonでは「#」、JavaScriptでは「//」や「/* */」を使います。
コメントアウトしたコードは削除してもよい？
もう使わないと分かっているコードなら、削除してもよいです。
ただし、あとで使う可能性がある場合は、しばらく残しておくこともあります。
複数人で作業している場合は、勝手に消さずに確認すると安心です。
HTMLのコメントアウトはSEOに影響する？
SEOとは、検索でページを見つけてもらいやすくするための工夫です。
通常、HTMLのコメントアウトは画面に表示される文章ではありません。そのため、検索順位を上げる目的でコメントアウト内にキーワードを入れても、よい効果は期待できません。
むしろ、検索順位を上げるために大量のキーワードをコメントアウト内へ入れるのは避けましょう。不自然なキーワードの詰め込みは、検索エンジンから低品質なページと見られるおそれがあります。
また、不要なコメントアウトが多いと、HTMLの量が増えてページが重くなることもあります。
SEOでは、読者に見えるタイトル、見出し、本文を分かりやすくすることが大切です。
コメントアウトできないときは何を確認すればよい？
まず、使っている言語に合った記号を使っているか確認しましょう。
HTML、Python、CSS、JavaScriptでは、それぞれコメントアウトの書き方が違います。
次に、記号の閉じ忘れがないか確認します。特にHTMLやCSSの複数行コメントでは、終わりの記号を忘れないようにしましょう。
まとめ：コメントアウトとは、コードを一時的に動かさないための書き方
コメントアウトとは、コードを消さずに残したまま、一時的に動かさないようにする書き方です。
プログラムの動きを止めたいとき、メモを残したいとき、正しく動かない原因を調べたいときに役立ちます。
コメントアウトの書き方は、HTML、Python、CSS、JavaScriptなど、使う言語によって違います。まずは、自分が使っている言語の基本の書き方を覚えるとよいでしょう。
Pythonで複数行をコメントアウトするときは、基本的に各行へ「#」を付ける方法が分かりやすいです。JSONは通常コメントアウトできないため、設定ファイルなどで使うときは注意しましょう。
また、VSCodeではショートカットキーを使うと、複数行をまとめてコメントアウトできます。解除するときも同じショートカットキーを使えます。
コメントアウトは初心者にも使いやすい便利な方法です。ただし、残しすぎるとコードが読みにくくなるため、必要に応じて整理することも大切です。