HTML5のコメントアウトの書き方と、コメントを利用してプログラムを分かりやすくする

HTMLHTML5, コメントアウト, プログラム

スポンサーリンク

HTML5でコメントを記述する際、コメントアウトを行えば良いです。

書き方ですが、具体的には以下になります。

記述するだけであれば簡単なのですが、実はプログラミングを学習するに当たってコメントアウトを行うのは非常に大事だと思っています。

スポンサーリンク

コメントアウトはプログラムを書く自分にとってもプログラムを読む他人にとっても重要である

コメントアウトを利用して先に実装する機能の処理を記述しておく

僕はプログラミングを習い始めの頃、講師の方に言われて印象的だったことがあります。

「コメントアウトはプログラムを読む人のためだけではなく、コメントにより記述すべき処理を最初に日本語で書いておくことで、自分の実装の間違いを減らしながら早く実装出来るんだよ。」

最初は半信半疑だったのですが、いざ言う通りに書いてみるとまさにその通りでした。

例えば、htmlには終了タグ(閉じタグ)の考え方があります。

この時、開始タグだけ書いて終了タグを書かずに先に中身を書く人は、間違いなくプログラムの実装の抜け漏れがあるでしょう。

それを防ぐのが、コメントアウトです。

事前にここからここまでに、どういう機能を実装するのかといった内容をコメントで記述しておけば、実装の日が経ってしまっていても何をしようとしていたのか一目瞭然です。

プログラムにおけるコメントとは、プログラムを読む人のために書くだけではなく、自分の実装の抜け漏れを無くすために書くという意識を持っておくと、上達が早くなること間違いなしなのです。

スポンサーリンク