サイト作成に便利!プロが教えるコメントアウトの使い方! | 福岡のホームページ制作はマリオ君にお任せ

為にならないブログ

見出しおじさん

BLOG

サイト作成に便利!プロが教えるコメントアウトの使い方!

2023年10月26日

サイト作成に便利!プロが教えるコメントアウトの使い方!

本日はサイト制作の効率を大幅にアップしてくれるコメントアウトの使い方についてご紹介させていただきます。

コメントアウトを利用することで、自分自身のコーディングの効率アップはもちろんのこと、複数人でホームページを作る際にもわかりやすく共有することができるのでとても便利です。

それではコメントアウトの種類と使い方の事例をご紹介させていただきます。

こんな方に向いている記事

  • コメントアウトって何?
  • 便利な使い方知りたい
  • 記事は若干いい加減でもいい
  • 少しでも為になれば

コメントアウトって何?

コメントアウトって何?

コメントアウトとはホームページを構成するHTMLやCSS・javascript・phpなどのコードを表面上のブラウザで(ホーページを見ている方に)見えなくして、内部(ソースコード)にのみ表示させるテクニックになります。

コメントアウトがされている部分はブラウザに表示されませんし、プログラム(javascriptなど)も実行されません。

内部にのみ表示できるのでメモ書きや注意書き・非表示・ホームーページの仕様方法など、制作者にのみ伝わるように書くことができます。

コメントアウト書き方

各言語によってコメントアウトの書き方が違うのでひとつずつご紹介いたします。
基本的には記号付きの文字で囲ってコメントアウトしますが、先頭にだけスラッシュスラッシュを記述し1行のみコメントアウトできる言語もあります。

■HTMLコメントアウト
<!--
と
-->
に挟まれている部分がコメントアウトになります。
<!--この部分はブラウザで表示されません-->
■CSS・javascript・PHPコメントアウト
/*
と
*/
に挟まれている部分がコメントアウトになります。

/*color:#FFF;この部分のCSSは適用されません*/
■SCSS・javascript・PHP一行コメントアウト

上記プラスで1行のコメントアウトもできます。
こちらは囲わなくていいので手軽にコメントアウトできます。

//color:#FFF;この部分のCSSは適用されません

スラッシュスラッシュに続く一行のみコメントアウトできます。
■PHP・htaccessのみできる一行コメントアウト
#get_template_partこの部分のPHPは実行されません

シャープに続く一行のみコメントアウトできます。

実務での使い方紹介

それでは私3流webデザイナーが普段使っているコメントアウト利用例を簡単にご紹介させていただきます。

閉じタグをわかりやすくする

これが一番よく使います。

divでレイアウトをしている際に入れ子をたくさんした場合などどれがどこの閉じタグかわからなくなることありませんか?コメントアウトを利用することによってどれがどれの閉じタグか簡単に見分けることができます。
コメントアウト無しの場合はこちら

<div class="wrapbg">
	<div class="wrap">
		<div class="cont">
			<div class="left">

			</div>
			<div class="right">

			</div>
		</div>
	</div>
</div>

divの閉じタグが4つ連続で並んでいるので少しわかりずらいですね。
これにコメントアウトを入れるだけで一気に見やすくなります。

<div class="wrapbg">
	<div class="wrap">
		<div class="cont">
			<div class="left">

			</div>
			<!-- ▲▲▲left end▲▲▲-->
			<div class="right">

			</div>
			<!-- ▲▲▲right end▲▲▲-->
		</div>
		<!-- ▲▲▲cont end▲▲▲-->
	</div>
	<!-- ▲▲▲wrap end▲▲▲-->
</div>
<!-- ▲▲▲wrapbg end▲▲▲-->

各閉じタグに合わせてクラス名を表記したコメントアウトを書きます。こうすることによりどれがどの閉じタグか一目でわかるようになります。

新規で作っている最中は、記憶がしっかりとしていてコメントアウトなしでも簡単に修正など対応できますが、作成後時間が空いた場合などはどれがどれだかわかりずらくなりますので、閉じタグにコメントアウトでクラス名を表記するのはめちゃくちゃおすすめです。

上記は調子に乗ってendとか英語を使っていますが、普段は終わりとか終了とかで記述しています。また▲もいれていますが、少し長さがあった方が見やすいので▲などをいれて幅を作ってコメントアウトを見やすくしています。

その他にはコンテンツごとにコメントアウトを入れるのもわかりやすいです。

<section class="newsbox">
	<div class="wrapbg">
		<div class="wrap">
			<div class="cont">
				<div class="left">

				</div>
				<!-- ▲▲▲left end▲▲▲-->
				<div class="right">

				</div>
				<!-- ▲▲▲right end▲▲▲-->
			</div>
			<!-- ▲▲▲cont end▲▲▲-->
		</div>
		<!-- ▲▲▲囲み終わり▲▲▲-->
	</div>
	<!-- ▲▲▲背景終わり▲▲▲-->
</section>
<!-- ▲▲▲▲▲▲▲▲▲▲▲▲最新情報のコンテンツ終了▲▲▲▲▲▲▲▲▲▲▲▲-->

こうすることにより、自分自身も管理しやすいですし、仮に他の方が改修する場合もわかりやすくなります。

一時的に隠す

一時的に非表示にしたい時に使います。

例として一時的にクラスleftが適用されているdivを消したい場合はこのようにします。

<section class="newsbox">
	<div class="wrapbg">
		<div class="wrap">
			<div class="cont">
				<!--<div class="left">
ここに記述されるものは非表示になります。
				</div>-->
				<!-- ▲▲▲left end▲▲▲-->
				<div class="right">

				</div>
				<!-- ▲▲▲right end▲▲▲-->
			</div>
			<!-- ▲▲▲cont end▲▲▲-->
		</div>
		<!-- ▲▲▲囲み終わり▲▲▲-->
	</div>
	<!-- ▲▲▲背景終わり▲▲▲-->
</section>
<!-- ▲▲▲▲▲▲▲▲▲▲▲▲最新情報のコンテンツ終了▲▲▲▲▲▲▲▲▲▲▲▲-->

制作中でお客様に確認していただく時などによく使います。

HTMLをまとめて隠すときは一工夫

コメントアウトをコメントアウトすることはできません。

newsboxをすべてコメントアウトする場合などは一工夫必要です。各閉じタグにコメントアウトを入れているので、全体をコメントアウトで囲うことはできません。

その場合はCSSで囲みます。
先ほどコメントアウトをコメントアウトできないと書きましたが、別の種類のコメントアウトはできます。こんな感じ

<style>
/*<section class="newsbox">
	<div class="wrapbg">
		<div class="wrap">
			<div class="cont">
				<!--<div class="left">

				</div>-->
				<!-- ▲▲▲left end▲▲▲-->
				<div class="right">

				</div>
				<!-- ▲▲▲right end▲▲▲-->
			</div>
			<!-- ▲▲▲cont end▲▲▲-->
		</div>
		<!-- ▲▲▲囲み終わり▲▲▲-->
	</div>
	<!-- ▲▲▲背景終わり▲▲▲-->
</section>
<!-- ▲▲▲▲▲▲▲▲▲▲▲▲最新情報のコンテンツ終了▲▲▲▲▲▲▲▲▲▲▲▲-->*/
</style>	

CSSで使用できるコメントアウト/**/を使用しています。HTMLファイルではそのままでは使えないので

styleタグで囲ってその中で

/**/

を使って全体をコメントアウトしています。

styleタグで囲ってCSS用のコメントアウトを使用することによって、HTML用のコメントアウトも併せてコメントアウトできるようになりました。

メモとして使用

CSSなどでファイルで分けずに記述する場合はメモとして利用したりします。

//▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼▼会話部分で使用

.topcont01{
	position: relative;
	padding: 0 20px 150px;//下への余白はコンテンツが増えたら消す又は100pxに変更する
	@include sp {
		padding: 0 0px 50px;
		//overflow: hidden;
	}
}
.line_d.current::before,
.line_d.current::after,
.line_d:hover::before,
.line_d:hover::after{
  width: calc(85%);/*横幅を100%に*/
}


//▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲▲会話部分で使用

こうすることでどの部分で使用しているCSSかわかりやすくなりますし、メモを入れておくことによって、どう変更すればいいか一目で理解することができます。

phpなどの場合もメモ(使い方)とし良く使用します。
特に私はプログラミングは得意でないのでワードプレスのループやjsの記述などは必ずメモで追記するようにしています。
ワードプレスのループではこんな感じでメモしてます。

<?php
$paged = get_query_var('paged')? get_query_var('paged') : 1;
$args = array(
    'post_type' => 'works',//スラッグをいれる
    'posts_per_page' => -1,//表示させたい件数をいれる 全部の時は-1をいれる
    'paged' => $paged,
);
$the_query = new WP_Query($args);
if ( $the_query->have_posts() ) :
while ( $the_query->have_posts() ) : $the_query->the_post();
?>

javascriptも同様にこんな感じでメモしてます

$("#g-nav a").click(function () {//ナビゲーションのリンクがクリックされたら
    $(".openbtn").removeClass('active');//ボタンの activeクラスを除去し
    $("#g-nav").removeClass('panelactive');//ナビゲーションのpanelactiveクラスも除去
});

メモをしておくだけで、どこをどう変更すれば変わるか一目で理解することができます。

注意点と変わり種の利用方法

便利なコメントアウトですが少しだけ注意が必要です。

コメントアウトされている文字などはブラウザで表示されることはありません。しかし、例外としてソースコード上には表示されます。

ウィンドウズでグーグルクロームを使用している場合

Ctrlボタン+Uでソース画面が表示されそちらではコメントアウトで隠されている文字列を見ることができます。

どういうことかというと、コメントアウトは隠しているだけで、消しているわけではないので見ようと思えばだれでも見ることができるので大切な情報(ログイン情報や個人情報など)は載せないように気をつける必要があります。

もう一つ変わり種の利用方法として、先ほど見ようと思えば見ることができるというのを逆手にとって、あえて隠し絵の様に遊び心で絵(アスキーアート)やメッセージを隠して入れることもできます。

代表例としては
スーパーマリオブラザーズで有名な任天堂さんです。

下記サイトに移動してソースコードを見るとマリオが描かれています。

任天堂さんニュースぺージサイト

ユニークなキャラクターで会社のキャッチコピーを入れられているのは富士そばさん
「あなたのおそばに富士そば」

富士そばさんのサイト

見る人がみればわかるところに、手を加えられているところに制作者様や企業様の情熱を感じますね。

まとめ

いかがでしたでしょうか?

コメントアウトを利用することで、自分自身も使いやすくなりますし、他の方に引き継ぐ場合なども便利なのでまだ利用されていない方は是非使ってみてください。

ここがチェケラ

ポイントです

POINT

コメントアウトはとっても便利!

それではまた。

カテゴリー

気になったら
連絡してね!

すいません

お電話は出れないことが多いので
ラインでもしもし・メールでもしもしが推奨です。

お時間をとらせていただきゆっくり
お電話させていただきます。

©Copy Rights MARIOKUN.All Rights Resarved.
Page Top
お問い合わせ

どうぞおじさん

作業中はお電話は出れないことが多いのでライン・メールでもしもしが推奨です。

お電話は出れないことが多いの折り返し致します。