HTMLとCSSにコメントを入れる方法
HTMLとCSSにコメントを入れる方法
今回は、HTMLとCSSにコメントを入れときの記述方法について書いています。お話は、次の順番で進みます。
コメントを入れる理由
HTML(またはCSS)コードには、次のような理由でコメントを入れておきます。
- コードが長く(多く)なってくると、どのような役割で書いたコードか読解に時間がかかる。
- 日が経つと、人間は忘れる。
- 自分以外の人でも、コードが理解し易くなる。
などなど。
HTMLのコメントの書き方
1:コメントの書き方
コメントを、「<!--」と「-->」で囲みます。(コメントは、HTMLをブラウザ表示したときに表示されません)
<!-- (コメント内容) -->
2:実際にコメントを入れる
復習もかねて、コメントを入れてみてください。うまくコメント(説明)できない場合は、理解が不足しているかもしれません。
すべてのタグにコメントを付けるのではなく、分かり難い箇所や、グループ、更新時の注意事項などを書くようにすると良いように思います。
3:入力例
(1)入力例1
短いHTMLコードであれば、次のように書く程度でも十分です。
(2)入力例2
ただ、HTMLコードが長くなってくると、特に<div>タグは、どことどこがペアなのか分からなくなってきます。
次の例のように、「▼」と「▲」を使って、視覚的にどこからどこまでが<div>タグのペアなのか示しておくと分かりやすいかもしれません。
4:FC2ブログサービスをご利用の方へ
さて、問題です。FC2ブログで使用しているテンプレートを見ていたら、次のようなコードを見つけました。これは、何でしょう?
<!--topentry--> 〜 <!--/topentry-->
まるで、コメントのようで紛らわしいのですが、これはコメントではありません。FC2ブログツールで設定している変数(変数タグ)と呼ばれるものです。
「邪魔なコメントだな」と考えて削除してしまうと、ブログが表示されなくなる可能性もあります。ご注意ください。
また逆に、「変数だと思っていたら、ただのコメントだった」という場合もあります。分かりやすい見分け方がないので、判断がつくようになるまでは、不用意に削除しないことが肝要かと思います。
CSSのコメントの書き方
1:コメントの書き方
コメントを、「/*」と「*/」で囲みます。
/* (コメント内容) */
2:実際にコメントを入れる
復習もかねて、コメントを入れてみてください。うまくコメント(説明)できない場合は、理解が不足しているかもしれません。
すべてにコメントを付けるのではなく、分かり難い箇所や、更新時の注意事項、CSSハックの内容などを書くようにすると良いように思います。
4:入力例
分かり難そうな箇所を中心に書いてみました。
あとがき
お疲れ様でした。HTML、CSSはいかがでしたでしょうか。
「意外に簡単だった」という人もいれば、「やっぱりダメかも・・・」という人もいらっしゃるかと思います。
しかし、結局のところ「慣れ」です。もし、「HTMLやCSSって、おもしろいかも」と思ったなら、続けてみてください。
その日は、まるで理解できなかったことも、次の日には、すんなり理解できる場合もあります。現時点での理解度は、あまり重要ではありません。重要なのは、モチベーションです。
次回予告
次回より、ブログのカスタマイズについて書いていきます。実際のテンプレートをいじって行くので、実は、これからがおもしろいわけです。
まずは、「カスタマイズの基礎テクニック」について書く予定です。
関連記事
CSSに関連する記事を、ご紹介します。
1:カスタマイズ前
2:CSSの基本的なこと
3:色の指定
4:罫線の指定
5:間隔(余白)の指定
6:継承と子孫セレクタ
7:箇条書き(リスト)
8:文字(フォント)の指定
9:idセレクタ、classセレクタ
10:文章を読みやすくする
11:文字の中央揃え(センタリング)
12:レイアウト
13:tableの中央揃え(センタリング)
14:CSSで飾る
15:まとめ
作成日:2008/05/19 更新日:2008/05/19
« 「CSS入門まとめ」|
コメントありがとうございます。
現在、コメントさんも、お休みしています。
こんちは
松嶋や、あぁ松嶋や、ポイズンやん
松島はいかがでしたか?日本三景のひとつですから、
なかなか美しい風景だと思うのですが、天気にもよるかしら。
コメント大事ですよね。
何しろ、divの開始と終了が離れていて、コメントが無くて、
divが入り子になっていると、もう泣きそうになります。
つい面倒で書いていないことが多いですけれども、
書いておくと本当に助かります。
「ありがとう、自分」・・・みたいな。(o゚ω゚o)
▲▲▲と▼▼▼は、私もまねっこです。
誰かのテンプレートで見かけたので、「こりゃ良いかも」と。
そうなんです。
画像サーバがまた不安定なのです。
FC2さんにメールしておきました。対応中になりました。↓
http://fc2support.blog85.fc2.com/blog-entry-202.html
みなさんに、ご不便をおかけして申し訳ないです。(´・ェ・)
そうです。
CSS入門が終わって、カスタマイズに入ります。
やはり、実際のテンプレートを例にしてお話した方が、
分かりやすいと思うので、4〜5本くらいは書く予定でいます。
その後は、新しいブログに比重をシフトして、
もろもろスキルアップを図りたいと思っています。
トラックバック
http://kumacrow.blog111.fc2.com/tb.php/300-b955e7b9

コメントの書き方って大事ですよね・・・とこの記事を読んで思いました。
自分のコメントは、コメントの意味を成していない気がするw
これからは見やすくて時間がたってもわかるコメントにしたい!
特に「おお」と思ったのが、▲▲▲と▼▼▼で視覚的にわかる書き方、
自分はstartとendで書いたりするんですが、どうもソース長くなると
コメント自体発見できなくて泣いたりするので・・・
まねっこさせて頂きます!イエー!
写真素材、なんか今うまく表示されない障害が発生してるらしく、
お花と楓見れませんでしたorz
kumaさんの画像の鯖は21なので、今障害真っ只中なはず。
あとでまた見に来て見ますね!
ところで、ブログカスタマイズの講座もされるのですか!
読んだ時、鼻穴広がった・・・
えっらい楽しみー!!!!!
ワクテカしてまってます!