コメントの書き方

プログラムソースには必ずコメントを書きましょう。

後でソースを見たときにどのようなプログラムかわかるように、 コメントを必ず書きましょう。 また、コメントはプログラムの一部分を無効にして(コメントアウトと呼びます)、 プログラムの動作をチェックするためにも使うことができます。

コメントの書き方

PHPでのコメントの書き方は、C言語でのコメントの書き方と、 シェルスクリプトでのコメントの書き方とが利用できるので、 わかりやすいでしょう。 プログラミングがはじめてという方は、ここでしっかり覚えておきましょう。

#  シェルスクリプト方式:行の終りまでコメントです。

// C言語方式:行の終りまでコメントです。

/* C言語方式:記号の間はコメントです。
   複数行のコメントを書くのに便利です。       */

「#」「//」は行の終りまでをコメントにする記号で、 短いコメントにはこれらを利用します。 「/* */」は、タグのように、この記号で囲まれた部分を全てコメントにします。 複数行コメントアウトできるので、長いコメントにはこちらを利用します。

コメントを書く理由

一見コメントを書くのは無駄な気がするかもしれませんが、 コメントは実は非常に重要なのです。 使い方には大きく分けると2つあります。

プログラム内容の説明をコメントに書く。

はじめてプログラミングをする人は驚くかもしれませんが、 これが最も重要なことです。 作っている最中はどのようなプログラムか覚えていますから、 コメントにわざわざ書くのは面倒くさいものです。 しかし、プログラムは一回書いたらおしまい、というものではありません。 プログラムを書き直すこともありますし、 新しくプログラムを書くときでも、 昔書いたプログラムを参考にすることがよくあります。 そのころには、どのようなプログラムだったかはたいてい忘れてしまいます。 コメントが書いてなかったら、ソースを一行一行確認しないといけません。 コメントが書いてあれば、どんなプログラムかすぐにわかりますよね。

それでは、どのくらいコメントを書けば良いのでしょう。 書きすぎてもいけません。 全部の行にコメントを書いたりしたら、 コメントが多すぎてかえって読みにくくなります。 適度な量にしましょう。 関数や処理のまとまりごとに、 何をしているかを書いておくぐらいが良いでしょう。

プログラミングを始めたばかりだと、 うまくコメントがつけられないかもしれませんが、 そのうちにうまくなりますので、 最初のうちは気にしすぎない方がよいでしょうね。

ソースの一部をコメントアウトする。

プログラム作成には、ミスがつきものです。 人間が作る以上、ある程度の間違いは避けられません。 作ったプログラムがうまく動かなかったとき、 怪しい個所をとりあえずコメントアウトして、 他の部分でエラーが起きなければ、 今コメントアウトした部分に何か問題があることがわかりますね。 このように、プログラムのチェックをするときにもコメントは役立ちます。

また、途中でプログラムを書き直す場合、 今までに書いたプログラムを残しておくと、 後で役立つことがあります。 このときにも、コメント機能が使えますね。 コメントアウトしたものを元に戻すのは簡単なので、 古いプログラムは消さないでおきましょう。

Copyright (C) 2003-2013. PHP で WEB 作成 All rights reserved.