コメントの書き方をもっと詳しく。見やすいコメント。

≪アメブロちょい足しCSS-Indexへ戻る-≫

コメントは、編集した箇所に何が書いてあるかを分かり易くする為にとても大事な存在です。
CSSのコメントは、原則的に「/*」で始まり、「*/」で終わります。

「/*この部分がコメント*/」

こんな感じが基本ですね。

しかし、後で見たときでも探しやすいコメントを書くには工夫が必要です。
スクロールバーでグルグルっとスクロールしても、見落とさないようなコメントの書き方をしましょう。
もちろん[Ctrl]キー＋[F]キーで目的の文字列を検索する事も一つの心強い手段です。

今回は、私が見やすいと思うコメントのサンプルをいくつか書いておきます。

【記述例】

/*--------------------------------------------
　　　　　　　　コメントがここに入る
---------------------------------------------*/

-(ハイフン)を使って線を引いて囲むのも見やすいと思います。

【記述例】

/*-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=


ここにコメントが入る


-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/

改行で空間を空けてコメントを書くのも探しやすいですね。
=(イコール)と-(ハイフン)の2種類を使っているので、目にも留まり易いです。

【記述例】

/*********************************************
*
*　　　　　　　コメントがここに入る
*
*********************************************/

こんなのもアリです。

【記述例】

/*■■■■■■■■■■■ここから○○○の編集*■■■■■■■■■■■*/

ここにCSSの記述

/*■■■■■■■■■■■ここまで○○○の編集*■■■■■■■■■■■*/

■(しかく)を使うと、色が黒くなるのでスクロールの際見つけ易いです。

…などなど、色々な書き方がありますが、自分に合った「/*コメント*/」を探してみてください。



【おまけ：これはどうだろう】

/*/*/*/*/*/*/ここにコメントが入る/*/*/*/*/*/*/

これはダメです。
数えてみれば分かりますが、コメントは「/*」と「*/」で囲まれた部分ですので、これではコメントアウト出来ていない部分が出来てしまいます。

コメント。
メメント。
メメント・モリ。

オーイ・メメントモリ (MFコミックス)/しりあがり 寿

￥1,260
Amazon.co.jp

面白い本だけど、妙に落ち込んでしまう本(´Ａ｀
愛読書なんだけどネ。

≪アメブロちょい足しCSS-Indexへ戻る-≫