Web制作でよく使う言語のコメント記述方法をまとめました。
■HTML
このように複数行書いても
大丈夫です
-->
■CSS
このように複数行書いても
大丈夫です
*/
こんな風に
/* コメントアウトの中にコメントアウトは書かない方が良いそうです */
*/
<間違い例>
× /* コメントアウトの閉じる側が変です→ /*
× */ ←コメントアウトの始まり側が変です */
× */ もちろん、両方とも逆になってもダメ */
■JavaScript
複数行にまたがって
コメントアウトします
*/
◎ちょっと閑話休題
CSSやJavaScriptをHTMLソースに記述する際、HTMLのコメントとして記述することがある(CSSやJSが<!-- -->でコメントアウトされている)が、これはCSSやJavaScriptのソースをHTMLテキスト扱いして表示してしまうブラウザがあったため。
しかし、現在のブラウザはそのような挙動をしないので、コメントアウトしなくても大丈夫。
ただし、携帯端末は見事にテキスト扱いしてくれたりする。
したがって、XHTML的にも実際問題としても、CSSやJavaScriptは“別ファイルに記述しましょう”というのが最近の流れ。
■Perl
# コメントアウトするのに
# １行ずつコメントアウトしてもOKだが
複数行まとめて
コメントアウトする書き方もある
=cut
コメントの始まりがコメントアウトされて
ここはコメント扱いされないのでエラーになります。
=cut
print <<"_TEXT_";
ここは実行されます。
_TEXT_
#=cut
この書き方もソースとは解釈されませんが、
podには意味があって、コメントとは違うので、
そういう場合には利用しません。
=cut
＊コメントアウトの記述方法自体をごにょごにょできるモジュールもある(さすがPerl!)みたいですが、それは割愛。
■Ruby
複数行が
コメントアウトされます
=end
=begin =endでコメントを書く場合は、RDと呼ばれる書式で記述されることが望まれます。
■Python
ダブルクオート３個で囲めば
複数行がコメントアウトできます
"""
ダブルクオートじゃなくて
シングルクオートでもOK
'''
'''
ブロック単位でコメントアウトする文字が２種類あるので
ネストできる
'''
"""
■PHP
JavaScriptと同様に、
複数行が
コメントアウトされます
*/
Perlのように
◎さいごに
「コメントアウトする」というのは「コメントにする」という意味です。
コメントをアウトするのではなく、ソースをアウトしてコメント(機能しないよう)にするというイメージです。
適度なコメントはソースを読みやすくしてくれます。
一般的に、一行ごとの詳細なコメントはうざがられます。処理のブロックごとにつける程度がいい塩梅ではないかと思ってます。
# コメントを書くのはソースを書くより難しい?!
# ソースコードと矛盾するコメントは、コメントが無いよりも問題である?!
