ブログをカスタマイズする時はタグの上に説明文を入れておくと後で困らない

スポンサーリンク

ブログに限ったことではないですが、修正箇所がどこにあるのか探すのに苦労したり、そのソースコードが何を表しているのか分からなくなったことはありませんか?もしあるならコードの上に説明文を入れれば解決されますよ。

スポンサーリンク

経験談

自分でプログラミングできる人はそのコードが何を表しているのか分かると思いますが、知識がないと何のコードなのか分かりません。下手にいじればどんな不具合がでるか心配です。

はてなブログのカスタマイズ記事を参考にして、コピペでカスタマイズしていると、これって何のやつだっけ?と分からなくなることが多々ありました。また修正するときも修正箇所がどこにあるのか探すのに目がチカチカすることも。

説明文をコードの上に書くようにしてからはこれらの問題が解決されました。

説明文の入れ方

<!– ここに説明文 –>

上のように<!– と–>の間に説明文を入れるとそのページを表示した時に説明文は表示されません。逆に説明文だけだと説明文が表示されてしまいます。

例えば説明文に「見出しの装飾」などと入れておくと、そのコードは見出しを装飾するためのものだというのが分かります。

ソースコードに説明文を入れておけば後から修正するときに修正箇所を見つけやすいですし、
それが何を表すコードなのか分からなくなるということがありません。

まとめ

タグの上に説明文を入れておくとそれが何を意味するコードなのかが分かるし、修正箇所を見つけやすい。後から困らないように説明文をつけておこう。