misc.log

日常茶飯事とお仕事と

コメントとコメントアウト

会社の新人向けに指摘しようと思って書き掛けた文章ですが、先輩方も含めて「細かすぎるんだよウゼェ」と思われる可能性があるのでこちらに書きます。こんなこと指摘されないようにしろよ、と言いたいところですがそれも飲み込んで。

開発の現場などで、よく誤用されるのですけどね、「コメント」と「コメントアウト」。多分英語がわかる人なら「アウト」が付く場合にどのようなニュアンス、意味が付与されるかはわかると思いますが……。

  • コメント …… 純粋な「注釈」「注意書き」。大半の場合、こちらを使えばよいはずです。
  • コメントアウト …… コメントでないものをコメントにすることで「本筋の処理から除外する」こと。

たとえば、処理の内容について補記する、それは「コメント」。プログラムなどの処理を訂正、変更する際に、もともとの処理記述を消してしまわずにコメントにすることでコンピューター(実際はパーサーやコンパイラー)に無視させる、これが「コメントアウト」。これを勘違いして「コメントアウト」で通す人がたまにいるので、間違えないように気を付けましょう。

という話。