自分用のメモも兼ねて、様々な言語のコメントアウト方法をまとめました。なお言語は個人的になじみのあるものとか、なんとなく選んだものとかです。
広告
コメントアウトとは
その名前の通り、コードの一部に書いたものをコメントにすることです。
コメントアウトした部分は、基本的にプログラムの動作結果には影響が無いため、注釈をつける・TO DOをメモするといった、つまりはそのまま「コメントをつける」ために用いられます。
各言語のコメントアウト方法
LaTeX
LaTeXでのコメントアウト方法は、%と書いた後ろに、コメント文を書くだけです。ただし、コメントできる範囲はその行に限られるので、改行すると、コメントの範囲から外れます。
つまり、
AAAAAAAAAAA
BBBB%CCCCCC
DDDDDDDD
という感じに書いている場合、「%CCCCCC」の部分のみがコメントアウトされるのです。こういう形を単一行コメントというようです。
なお、複数行に渡ってコメントとする場合は、\if0とfi\で囲むという手もありますが、こちらによると、安全なやり方は、
\userpackage{comment}を記述しておき、コメントしたい部分を\begin{comment}と\end{comment}で囲む、というものになります。この場合は囲んだ部分が全てコメントになります。
まあでも、大体のエディタが対応しているのは%なので、こまめに%でコメントアウトをかけてみてもいいのではないかと思います。
C/C++
単一行コメントは//、複数行コメントは/*と*/で挟むという形です。
Java
JavaもC/C++と同じく、単一行コメントは//、複数行コメントは/*と*/で挟むという形です。
EclipseではCtrl + /で選択行、あるいはドラッグで選択していた複数行にコメントアウトを行えます（選択していた行の先頭に単一行コメントである//が追加される形）。解除も同じショートカットです。
Ctrl + Shift + /を使うと、/*と*/を使った形のコメントアウトが行えるらしいです。解除はコメントアウト部分の一部を選択して、Ctrl + Shift + \を押す形のようです。Eclipseのショートカットについて詳しくはこちらを参照。
PHP
PHPもC/C++、Javaと同じく、単一行コメントは//、複数行コメントは/*と*/で挟むという形でコメントアウトが可能です。
また、#という形でも単一行コメントが可能です。
PHPは<phpと?>で囲む中にコードを書くこともありますが、例えば<php # AAA ?>とした場合、# AAAのみがコメントアウトされ、囲んだ外までコメントアウトはしないようです。
HTML
HTMLでは、<!–と–>でコメントにしたい部分を囲むことで、コメントアウトが行えます。
ただ、コメントタグでコメントを含む塊をコメントアウトすることは出来ません。
つまり、
<!–
BBB
<!– AAA –>
CCC
–>
とした場合、どうやらCCCと、末尾の–>の部分がコメントアウトされる部分から除かれるようです。
その場合のテクニックとして、<style>/* と */</style>で囲んだり、<script>/* と */</script>で囲むというのもあります。ただ、勿論、これはおそらく本来の使い方ではないと思うので、コメントタグをコメントタグで含まないようにして、気をつけてコーディングしたほうがいいのではないかと思います。
CSS
単一行コメントではなく、ただ、/*と*/で囲んでコメントアウトする方式です。例: /* AAA */ とすると/* AAA */の部分がコメントアウトされる。
JavaScript
こちらもJava、C/C++などと同じく、単一行は//の後をコメントアウト、複数行コメントは/*と*/で挟むという形になっています。HTMLのときに書いたテクニックも、このコメントアウトの方式を利用したものです。
Python
括弧もあまりない、シンプルな言語らしく、コメントのやり方もシンプルです。なんというか、シェルスクリプトライク？というのかしら。
単一行では#の後にコメントを続ける方式で、コメントアウトを行います。
また、シンプルな言語であるからか、複数行に渡るコメントアウトの記号はないみたいなのですが、こちらによると、プログラムの中に書かれた文字列は実行に影響を及ぼさない、というのを利用して、”'(シングルクオーテーション3つ)どうしの間か、”””（ダブルクォーテーション3つ）どうしの間にコメントを挟むことでコメント複数行単位のコメントを可能とする方法もあります。ただこの場合、インデントがいるみたいなので、なんかもう単純に#でやってしまってもいいのではないかと思います。最近のIDEには、そういうショートカットもあるでしょうし。
tyranoscript
ティラノスクリプトでは、単一行のコメントは「;」をつけることで実現され、複数行のコメントは/*と*/で囲む形式となります。
IDEでの色々
コメントアウト方法については、色々ありますが、コメントアウトを一括で行える機能を持っているIDEもあるようです。ただ、コメントの形式が色々あるので、言語を変えたときその都度コメントアウトを行うショートカットは確認したほうがいいかもしれません。
表での一覧
| 言語 | 単一行コメント | 複数行コメント |
|---|---|---|
| LaTeX | % | \begin{comment}~\end{comment} |
| C/C++ | // | /* ~ */ |
| Java | ||
| PHP | // or # | |
| HTML | <!– ~ –> | |
| CSS | /* ~ */ | |
| JavaScript | // | |
| Python | # | ”’ ~ ”’ or “”” ~ “”” (インデントに注意) |
| ティラノスクリプト | ; | /* ~ */ |
まとめとかコメントとか
コメントアウトについて、自分用の防備録も兼ねて作成しました。一覧形式にすると（私が防備録として使うときに）目移りしてややこしくなってしまいそうなので、目次をつけて各項目にメモっていく形と、表形式で一括でまとめる方式と2つにしています。