記事の内容
この記事では、PHPのコメントアウトとPHPDocについて説明します。
PHPのバージョンは、7系です。
コメントアウトとは何か?
コメントアウトとは、プログラムのソースコードなどを編集する際に、特定の箇所をコメント化して一時的に無効化することです。
あとで復活させる可能性が高いけど、一時的にコードを無効化したい時に使います。
コメントアウトのやり方
PHPのコメントアウトには、三つの方法があります。
- 行頭に「//」をつける方法
- 行頭に「#」をつける方法
- /* */で囲む方法(PHPDocコメントと紛らわしいので、非推奨)
PHPDoc
PHPDocとは、クラスや関数などの機能を説明するために、コード内に記述する書式の通称です。
PHPDocを用いることで、 PHP のコードから自動でドキュメントを生成することができます。
様々な書式があるので、詳細はこちらを確認して下さい。
PHPDocは、「/** */」で囲みます。