PHPでコメントする方法

コメントとは注釈の一種で、コードの目的や意図を明確にするために使用します。PHPを使用する際には、1行のコメントと複数行のC言語スタイルのコメントの2つの選択肢から、人気のある古い言語に由来するいくつかのオプションを選択することができます。コメントを使用することで、コードの一部を実行しないようにしたり、 ドキュメントの作成に使用したりすることができます。

パート1

スタイル

1. 短いコメントには一行コメントを使う。短いコメントを残す必要がある場合は、単一行コメント・コードを使うことができます。コメントは行末またはコードブロックの末尾までしか続きません。これらのコメントはPHPタグの中でしか機能しません。
2. 長いコメントやコードのテストには、複数行コメントを使用します。複数行コメントは、長い説明を書いたり、コードの一部が処理されないようにしたりするのに便利です。複数行コメントを使用する際のヒントについては、以下の「使用法」のセクションを参照してください。

パート2

使い方

1. コメントは、コードがどのように動作するかについてのメモを残すために使用します。良いコードは他のプログラマーが解析しやすいものであるべきなので、すべてのコード行に対してこれを行う必要はありません。コードが不規則であったり、明らかでない機能を実行している場合に便利です。

   // curl リクエストを生成する $session = curl_init($request); // HTTP POST を使うように curl に指示する curl_setopt ($session, CURLOPT_POST, true)；
2. コメントを残しておくと、自分が何をしていたかを思い出せます。自分のプロジェクトで作業しているときは、コメントを残しておくと、どこで作業を中断したかを思い出しやすくなります。正しく動作していないコードや、まだ完成していないコードにはコメントを残しましょう。

   // 次に進む前に、この出力をもう一度確認する必要がある echo "Hello World!
3. 共有するコードにコメントをつける。他の人と共同作業をする予定があったり、コードをオープンソースにする予定があったりする場合は、コメントを書くことで、他の人があなたのコードがどのように機能し、どこを改善するのがベストなのかを知ることができます。

   /* これを達成するためにもっと効果的な方法はありますか？*/ 性別: value="女性">女性 value="男性">男性
4. コメントを使用して、特定のコードブロックを実行させないようにします。これは、テスト中に特定のコードが実行されないようにする必要がある場合に便利です。コメントタグに含まれる内容は、ページが読み込まれたときに無視されます。

   ?
5. 大きなコード・ブロックをコメントアウトするときは注意してください。コメント関数は、最初の終了タグがヒットするたびに終了するので、コメントアウトするコードの中にすでに複数行のコメントがある場合、コメントは元の入れ子になったコメントの終わりまでしか続きません。

   ?

   
   

   ?
6. コメントを使って擬似文書を作成する。コードの書式を工夫することで、コードの中に直接ドキュメントを作成することができます。これはオープンソースのプロジェクトで役立ちます。

   ?

この記事は、CC BY-NC-SAの下で公開されている " How to Comment in PHP " を改変して作成しました。特に断りのない限り、CC BY-NC-SAの下で利用可能です。