PHP コメントの書き方

概要

PHP等のプログラミング言語では、どうしてその処理を実行するのか、

ソースだけだと分かりづらい状態になってしまいます。

どうしてその処理を書いたのか分かりやすく日本語などで説明を加えることで、自分以外のプログラマがソースを見た時に瞬時に理解できます。

また、開発途中で一時的にこの処理を動作しないようにするなど、コメントの使い方は様々です。

コメントアウトとは

「プログラムの中に書き込まれた、処理の記述以外の説明文のことをコメントという。」

コメントアウトを使うポイントとしては、メモとして使ったり、
プログラムを一時的に処理しない状態にしたり、
PHP Docというクラスやメソッドの定義前に決まったフォーマットでブロックコメントをすることでドキュメントを自動生成できたりします。

PHPのコメントアウトをしてみる

1行コメント //#

ブロックコメント /* */

PHP Docサンプル

クラス Class

メソッド Function

まとめ

  • PHPのコメントは3種類
  • 1行コメントとブロックコメントがあります。
  • #コメントは非推奨だけどPythonも同じです。
  • PHP Docを意識して書くことでソースの共有が簡単になります。
  • プログラマしては、コメントが無くてもわかりやすいソースコードにすること大切です。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です