2018年のPHPDoc事情とPSR-5 - Qiita
PHPDocとは、クラスや関数などのブロックに記述できるDocComment内に記述する書式の通称です。この書式の情報源として時折PSR-5が参照されることがあるので簡単に状況をまとめます。 TL;DR PSR-5の標準化ステータスは昨年10月にABANDONED (放棄・議論停滞)になりました 2018年9月26日にPSR-5とPSR-19が分割され、ともにDRAFT状態に入りました PHPDocを型注釈として利用する各処理系の実装にはばらつきがあり、PSR-5とは相違点があります PhpStormは現在のところ(2018.1 EAP)PSR-5と互換性がありません 特にチーム開発では、対応する型記述の書式について注意が必要です PhpStormに配慮して書く場合、phpDocumentorの仕様を参照する方が安全です PHPDoc リファレンス — phpDocumentor この記事
【PhpDoc】コメントの書き方のまとめ – 小俣泰明(タイメイ)ブログ@アルサーガパートナーズ
関数/メソッドの場合 例文 /** * 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とは？
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
