プログラミングをしているときにわからないことがありググったときに、 「コメント」を使用すべき箇所で「コメントアウト」という単語が使用されていることがままあります。
プログラミングにおいて、「コメント」と「コメントアウト」、そして「コメント化」はそれぞれ違う意味を持ちます。
「コメント」とは
「コメント」とは、 「ソースコード中にメモなどを記述するために、特別な構文等を使用して記述した、 プログラムとして解釈されない文字列、またその内容」 です。
英語の「comment」の「注釈・解説」という意味そのままです。
コメントを記述するための「コメント構文」を使用して書かれている文字列全般を指します。
コメント構文には、
- C/C++やJava等では「
//」や「/* ～ */」など - RubyやPython等では「
#」など
が用いられます。
こちらは、言語によって定められています。
ここで言いたいことは、「コメント」は単なる「文字列」ということです。
「コメントアウト」とは
こちらは、 「コメント構文を使用して、ソースコードをコメントに変え、 一時的にプログラムを無効化すること」 を言います。
ソースコードをコメントにするとプログラムとして解釈されないため、 ソースコードを削除したように動かすことができます。
デバッグを行うときによく利用されています。
「この行を削除したらどうなるんだろう？ でも削除してしまうと戻せなくなってしまう……」
そんなあなたにコメントアウト！
簡単に削除した動きが実現できます！
英語の「out」がくっついたことにより、「コメントによって取り除く」といった意味になります （プログラムの動きの外に出すイメージです）。
言いたいことは、「コメントアウト」は「自分が行う動作」です。
「コメント化」とは
「コメント化」と言うこともあります。 これは、「文字列がコメントになる」という意味です。
よく「コメント化する」というように使われます。
これは「状態の変化」です。
まとめ
- 「コメント」は「文字列」
- 「コメントアウト」は「自分が行う動作」
- 「コメント化」は「状態の変化」
ですので、これらはすべて違うものです。
間違えないように注意しましょう！
例文
- コメントにはプログラムの意図を書きましょう。
- ここがコメントになっていないのでエラーが発生している。
- コメントアウトしてデバッグしてみよう。
- コメントアウトしているところを元に戻そう。
- この行はコメント化してください。
