コメントアウトとは?やり方と活用方法

トモジのアイコン画像トモジ

コメントアウトって何?
意味と活用方法を知りたい!

本記事は、
上記のような方に向けて記事を書いています。

こんにちは、トモジです。

私はプログラミング未経験から独学で勉強して、
簡易的な動的サイト・ゲーム・サービスが作れる状態になりました。

本記事は、これから勉強を始めるあなたに
コードやプログラミングのコメントアウトに関して要点をわかりやすく説明しております。

記事の内容

1.コメントアウトとは?

コメントアウトとは、特殊な記号を用いてコードやプログラミングが処理されない状態にして
メモや解説を記載することを言います。

コメントアウトは言語や行数によって
少しだけ記述方法に違いがありますので
違いについて見ていきましょう。

言語別コメントアウトの違い

今回のコメントアウトは私が勉強で接したHTML・CSS・JavaScript・PHPに限定して説明します。

HTMLのコメントアウト

HTMLのコメントアウト方法は
開始が[<!–] 終了が[–>]ではさむ形になります。
※1行と複数行同じ記載になる

HTMLのコメントアウトの説明図
HTML記述

CSSのコメントアウト

CSSのコメントアウト方法は
開始が[/*] 終了が[*/]ではさむ形になります。
※1行と複数行同じ記載になる

cssのコメントアウトの説明図
CSS記述

JavaScriptのコメントアウト

JavaScriptのコメントアウト方法は2種類あり
1行コメントアウトは開始に[//]とつけ、
複数行はCSSと同じになります。

javascriptのコメントアウトの説明図
JavaScript記述

PHPのコメントアウト

PHPのコメントアウト方法は3種類あります。
1行コメントアウトは開始に[//]か[#]をつけ、
複数行はCSSと同じになります。

PHPのコメントアウトの説明図
PHP記述

2.コメントアウトで見やすくしましょう

コードやプログラミングの量が膨大になってくると瞬時に判断するのが難しくなってきますので
コメントアウトを活用して見やすいコードやプログラミングを心がけましょう。

まとめ

最後にこの記事のポイントをまとめておきます。

記事のまとめ

HTMLのコメントアウト

1行と複数行コメント

  • 開始<!--と終了-->で挟み込む

CSSのコメントアウト

1行と複数行コメント

  • 開始/*と終了*/で挟み込む

JavaScriptのコメントアウト

1行コメント

  • 開始に//を入れる

複数行コメント

  • 開始/*と終了*/で挟み込む

PHPのコメントアウト

1行コメント

  • 開始に//#を入れる

複数行コメント

  • 開始/*と終了*/で挟み込む

コメントアウトは見直しをする時に非常に役に立ちますが
あまりにも細かくコメントアウトを駆使するとかえって見づらくなります。

コードやプログラミングの効果を確認する時や
大枠の把握・内容の意味を簡易的に判断できるようにする時などに使用するといいと思います。

記事の内容
閉じる