関数/メソッドの場合 例文 /** * aaaの説明 * * @param string $arg 第一引数 * @param integer $arg2 第二引数 * @return array 戻り値の説明 */ function aaa($arg,$arg2){} 型 string integer object(オブジェクト) array mixed(いろんな型が返る場合), resource(リソース型) 変数/define定数 /** * 説明 * @see 関連関数 */ のように書きます。 クラスの場合 /** * クラスの説明 * * @package パッケージ名:ここは、自分でうまく分類作れれば見やすくなる * @author 作った人 * @since PHP 5.3 PHPのバージョンとかいれときます? * @version 1.0.1 */ DocBlockとは?
![【PhpDoc】コメントの書き方のまとめ – 小俣泰明(タイメイ)ブログ@アルサーガパートナーズ](https://cdn-ak-scissors.b.st-hatena.com/image/square/147ea2abd6476b1892ef84724659a09a702e4f49/height=288;version=1;width=512/https%3A%2F%2Fi1.wp.com%2Fblog.flavacube.com%2Fwp-content%2Fuploads%2F2022%2F08%2Fimage.jpg%3Ffit%3D640%252C640%26ssl%3D1)