PHP

PHPのコメントについて

概要

コメントの書き方について、少し意識をしたいと思って調べた内容を自分用にメモしておく。

コメントの書き方

そもそもどう書くの?。
PHPDoc reference

最低限書きたいコメント

調べていたら、同じ考え方の記事があったので、そのまま流用させてもらいます。

最低限書いておきたいPHPのDocコメント

入力/出力の各値の型が分かれば(統一されていれば)使うことができる。

型を意識していないコードとかも頻繁に見かけるので、
最低限下記のコメントを書き、型について意識して欲しいと思う。

<型に関するアノテーション>

以上

参考サイト