<PHPLearn/>
PHP基礎 レッスン11

コメント

一行コメント、ブロックコメント、PHPDocの書き方を学びます。

コメントの種類

コメントはプログラムの説明を書くためのもので、実行時には無視されます。コードの意図を伝えたり、一時的にコードを無効化するのに使います。

  • //: 一行コメント(C++スタイル)
  • #: 一行コメント(Shellスタイル)
  • /* ... */: ブロックコメント(複数行)
  • /** ... */: PHPDocコメント(ドキュメント生成用)

一行コメントとブロックコメント

コメントは実行されません。コードの説明や一時的な無効化に使います。

PHPエディタ

PHPDocコメント

PHPDocは関数やクラスのドキュメントを自動生成するための特殊なコメント形式です。

PHPエディタ

コメントのベストプラクティス

良いコメントは「何をするか」ではなく「なぜそうするか」を説明します。

PHPエディタ