コメントアウトとは、プログラムソース内に処理ロジックとは別に
コメントとして残す事を言います。
今回は、様々なプログラム言語やフレームワークで使用する
コメントアウト記法を纏めました。
コメントアウトはプログラムを書く上で、とても頻繁に使い、
プログラム言語を覚える時にも一番初めに確認して起きたい記法です。
新しいプログラム言語を勉強する際は、是非とも下記より
該当のプログラム言語を選択し、コメントアウト記法を見につけて下さい。
【 今回掲載したコメントアウト記法 】
- HTMLのコメントアウト記法
- CSS(スタイルシート)のコメントアウト記法
- バッチ(bat)、バッチファイル内でのコメントアウト記法
- PHPのコメントアウト記法
- JavaScriptのコメントアウト記法
- VBAのコメントアウト記法
- Javaのコメントアウト記法
- MySQL等で使用するSQL文のコメントアウト記法
- C言語でのコメントアウト記法
- C++のコメントアウト記法
- Objective-Cのコメントアウト記法
- Texのコメントアウト記法
- Perlのコメントアウト記法
- XMLのコメントアウト記法
- Rubyのコメントアウト記法
- JSPのコメントアウト記法
- LinuxのBシェル(sh)でのコメントアウト記法
- Pythonのコメントアウト記法
- VBSのコメントアウト記法
- Smartyのコメントアウト記法
- ASPのコメントアウト記法
- Fortranのコメントアウト記法
- aspxでのコメントアウト記法
HTMLのコメントアウト記法
HTMLのコメントアウト記法は、
『<!-- 』と『 -->』の間がコメントとして認識されます。
複数行に渡るコメントでも問題ありません。
そして、コメントの中にはHTMLタグを含める事も出来ますが、
コメントアウト内のコメントアウトを記述する事は出来ません
また、IEではコメントアウト記法を利用した
条件文を記述出来ます。
もちろん、IEだけ反応する条件式なので、
他のブラウザでは通常通りコメントアウトとされますので安心です。
記法と致しましては、
『<!-- [if 条件]>』から『<![endif]-->』までが
条件に該当した時に実行される内容です。
IEにて指定出来る条件は下記の通りです。
[if IE] | IE だったら |
---|---|
[if !IE] | IE では無かったら |
[if IE 7] | IE7 だったら |
[if lt IE 9] | IE9 未満だったら |
[if lte IE 9] | IE9 以下だったら |
[if gt IE 9] | IE9 より大きければ |
[if gte IE 9] | IE9 以上だったら |
[if (gte IE 6) & (lte IE 8)] | 条件を『&』で連結する事も可能。この場合は、IE6より大きく、IE8以下だったら実行 |
[if (IE 7) | (IE 8)] | 条件を『|』で複数指定する事も可能。この場合は、IE7もしくはIE8だったら実行 |
[if true] | 常に実行する |
[if false] | 常に実行しない |
CSS(スタイルシート)のコメントアウト記法
CSSのコメントアウト記法は、
『/* 』から『 */』までがコメントアウトされます
複数行でも『/* 』から『 */』までがコメントアウトされます
特に、一行コメント用の記法は用意されていないようです。
/* ここがコメントアウトされます */ /* 複数行でも コメントアウトされます */
バッチ(bat)、バッチファイル内でのコメントアウト記法
バッチのコメントアウト記法において、
一行コメントの方法は三つ用意されています。
『rem』コマンドを使用するか、『::』から始まる行、『: 』(コロン+半角スペース)から始まる行でも
コメントアウトが可能です。
複数行のコメントアウト記法は現時点では用意されていません。
ですので、複数行をコメントアウトするには、行数分のremなりを記述する必要があります。
rem この部分がコメントです ::この部分もコメントです : そしてこの部分もコメントです rem 複数行の rem コメントアウトは rem この様に書く
PHPのコメントアウト記法
PHPのコメントアウト記法において、
一行コメントアウトの記法は二種類用意されており、
共に記述した箇所から行末までをコメントアウトします。
記法は『//』か『#』です。
複数行コメントは『/*』から『*/』の囲った範囲内がコメントアウトされます。
// ←から行末までコメントアウトされます # シャープでも一行コメントアウトが可能です。 /* 複数行が コメントアウトされます */
JavaScriptのコメントアウト記法
JavaScriptのコメントアウト記法では、
一行コメントは『//』から行末までがコメントアウトされます。
複数行コメントは『/*』から『*/』の囲った範囲内がコメントアウトされます。
// 行末までコメントアウトします。 /* 複数行の コメントアウトも 可能です。 */
VBAのコメントアウト記法
VBAにてのコメントアウト記法は、『'』(シングルクォーテーション)から行末までをコメントアウトします。
また、remコマンドでもコメントアウトする事が可能です。
ただ、remコマンドの場合は行の先頭に書く必要があり、
『'』(シングルクォーテーション)でのコメントアウトは行の途中からでも
コメントアウトが出来る違いがあります。
複数行コメント用の記法は用意されていませんので、
一行コメントを続けて書く事で対応します。
' ここはコメントです rem ここはコメントです Dim IntNumber As Integer 'ここもコメントです。remはこの様には書けません rem 複数行のコメントは rem この様に一行コメントを rem 連続して書く事で対応します。
Javaのコメントアウト記法
Javaのコメントアウト記法において、
一行コメントでは『//』以降から行末までコメントアウトされます。
また、複数行コメントアウトは『/*』から『*/』までをコメントアウトとします。
そして、Javaには少し特殊なコメントアウト記法が存在し、
コメントをjavadocツールによってドキュメント化を伴うコメントアウト記法も存在します
(コンパイル時には通常のコメントアウトに変換されます。)
記述方法は、『/**』から『*/』までをドキュメント化対象とした上でコメントアウトします。
// 一行コメントです。 /* 複数行の コメントアウトです */ /** javadocツールによってドキュメント化する事の出来るコメントです */ /** javadocツールによって ドキュメント化する事の出来る 複数行の コメントアウトです */
MySQL等で使用するSQL文のコメントアウト記法
SQL文の一行コメントでは『--』以降から行末までコメントアウトされます。
複数行を纏めてコメントアウトするには、『/*』から『*/』まで囲います。
-- 1行コメント -- select hoge from moge; /* 複数行コメント 纏めてコメントアウト出来ます。 select hoge from moge; select test from test_table; */
C言語でのコメントアウト記法
C言語では、『/*』から『*/』迄をコメントアウトします。
また、一行コメント用の記法は用意されていないので、
一行でも複数行でも、コメントアウトしたい部分は『/*』から『*/』で囲います。
/* 一行コメント */ /* 複数行の コメントアウトも 可能です */
C++のコメントアウト記法
C++でのコメントアウト記法は殆どC言語と同じで、
基本は『/*』から『*/』迄をコメントアウトしますが、
C++では一行コメント用の記法も用意されています。
記法としてh『//』から行末までをコメントアウトします。
// 一行コメント。行末までをコメントアウトします。 /* 複数行の コメントアウトも 可能です */
Objective-Cのコメントアウト記法
Objective-Cのコメントアウト記法はC++と同じで
『/*』から『*/』までを複数行コメントアウトとし、
『//』から行末までを一行コメントとします。
一行コメントは行の途中からの記述でも問題ありません。
// 一行コメント。行末までをコメントアウトします。 NSString = @"hoge"; // 行の途中からのコメントも可能です。 /* 複数行の コメントアウトも 可能です */
Texのコメントアウト記法
Texでは、一行コメントに『%』を使用し、記述箇所から行末までをコメントアウトします。
複数行コメントは条件文の様な書き方で、
『\if0』から『\fi』までをコメントアウトします。
また、『\usepackage{comment}』で宣言した後であれば
複数行コメントを『¥begin{comment} 』から『¥end{comment}』迄の間に
書く記法も使用出来ます。
% この行がコメントアウトされます。 \if0 複数行を コメントアウト する事が出来ます \fi % 複数コメントを扱うには宣言が必要 \usepackage{comment} ¥begin{comment} 複数行を コメントアウト する事が出来ます ¥end{comment}
Perlのコメントアウト記法
Perlでは、一行コメントに『#』を使用し、記述箇所から行末までをコメントアウトします。
そして、複数行のコメントアウトは『=comment』でコメントアウトを開始して
『=cut』にてコメントアウトを終了します。
# 一行コメントです。 =comment 複数行の コメントアウトは この様に記述します。 =cut
XMLのコメントアウト記法
XMLでは、HTMLと同じように一行コメントも複数行コメントも
『<!--』から『-->』までの間に記述します。
ですが、制限事項としてタグ内でコメントアウトする事は出来ません。
そして、コメントアウト中に『--』の様にハイフンを連続して二つ続ける事は出来ません。
Rubyのコメントアウト記法
Rubyのコメントアウト記法は、殆どPerlと同じです。
一行コメントアウトには『#』を使用し、
複数行コメントアウトには『=begin』で開始して『=end』でコメントアウトエリアを
終了します。
# 一行コメントアウトです。 =begin 複数行を 纏めてコメントアウト出来ます。 =end
JSPのコメントアウト記法
JSPのコメントアウト記法では、一行コメントも複数行コメントも
『<%--』から『--%>』迄の間に記述します。
<%-- 一行コメントです。 --%> <%-- 複数行でも 一行コメントと 同じタグを使用します。 --%>
LinuxのBシェル(sh)でのコメントアウト記法
LinuxのBシェル(sh)で一行コメントを記述するには、
行頭に『#』を記述する事で、行末迄をコメントアウトします。
ただ、スクリプトの一行目ではスクリプトを指定する記述ですので、その場合の『#』は通常通り実行されます。
また、複数行コメント様の記法は用意されていません。
# この行はコメントです。 # 複数行コメントアウトは # この様に一行コメントを # 並べる形をとります。
Pythonのコメントアウト記法
Pythonのコメントアウト記法では、一行コメントを『#』の後に記述し、
複数行コメントは二種類の記法が用意され、
『"""』から『"""』迄をコメントアウトとする方法と、
『'''』から『'''』迄をコメントアウトとする方法の二種類です。
このシングルクオートとダブルクオートは、
ネストする事も出来ます。
(ダブルクオート内でシングルクオートのコメントアウトを記述出来る)
# 一行コメントアウト """ ダブルクオート3つで囲んだ部分が 複数行でも 纏めてコメントアウト出来ます。 """ ''' シングルクオート3つで囲んだ部分が 複数行でも 纏めてコメントアウト出来ます。 ''' """ ''' 複数行のコメントアウトは ネストにも対応していますので、 複数行コメントアウト内で さらにコメントアウトする事も可能です。 ''' """
VBSのコメントアウト記法
VBSのコメントアウト記法は、殆どVBAのものと同じ記法にて行います。
まず、一行コメントでは『'』(シングルクォーテーション)から行末までをコメントアウトします。
また、remコマンドでもコメントアウトする事が可能ですが、先頭に書く必要があります。
『'』(シングルクォーテーション)でのコメントアウトは行の途中からでもコメントアウトが出来ますので、
コチラの方が柔軟性があって使いやすいでしょう。
複数行コメントアウト用の記法はありませんので、
一行コメントを連続して記述する事で対応します。
' ここはコメントです rem ここはコメントです Dim IntNumber As Integer 'ここもコメントです。remはこの様には書けません ' 複数行のコメントは ' この様に一行コメントを ' 連続して書く事で対応します。
Smartyのコメントアウト記法
Smartyでのコメントアウト記法は、一行コメントも複数行コメントも
同様の記法を使用します。
『{*』から『*}』までをコメントエリアとし、
ブラウザへは送信され無い様にする事が出来ます。
{* この部分がコメントです。 *} {* 複数行に渡るコメントも 同じ記法で対応可能です。 *}
ASPのコメントアウト記法
ASPでのコメントアウトは、一行コメントこの記法だけ用意されており、
『'』シングルクォーテーションの後から行末までをコメントアウトします。
複数行のコメントアウトには一行コメントを連続して記述する事で
対応しましょう。
' コメントアウト行です。 Response.Write("Hello World!!") ' 行の途中からでもコメントアウト可能です。 ' 複数行のコメントアウトは ' 一行コメントを連続して書く事で ' 対応しましょう。
Fortranのコメントアウト記法
Fortranでのコメントアウト記法として、
一行コメントの記法は三つ用意されていますが、
複数行コメント用の記法は用意されていません。
一行コメントは行頭に『c』と記述すれば、その行はコメント扱いとなり
『*』と書いてもコメント扱いとなります(厳密にはプログラム行から除外される)
もう一つのコメントアウトの記法として
『!』から行末迄をコメントアウトとします。
先程の二つの違いとしては、『C』と『*』は行頭に記述する必要があるのに対して、
『!』では行の途中からでも記述出来ます。
複数行に渡ってコメントアウトしたい場合は、
一行コメントを複数行記述する事によって対応します。
c この行はコメントです。 * この行はコメントです。 ! ここから行末までコメントです。 a = a + 1 ! この用に、行の途中からでも行末までコメントアウトされます。 ! 複数行に渡るコメントは ! この様に一行コメントを ! 連続して書く事で対応します。
aspxでのコメントアウト記法
aspxでのコメントアウトは、『<%--』から『--%>』迄をコメントアウトとします。
サーバ上では処理され無い様になりますが、空白が出力されますので、
注意が必要です。
<%-- サーバ上で処理はされないが、空白が出力される --%> <%-- 複数行のコメントアウトも 同じように記述します。 --%>
主要な言語やフレームワークのコメントアウト記法を纏めました。
他にもコメントアウトの知識を身につけたら随時追記して行きたいと思います。
もし、この記事に載っていない言語でのコメントアウトの記法に関する
情報がありましたら、どしどしコメントして頂ければ幸いです。