DocComment
関数
や
クラス
、
プロパティ
などの定義前に書く特殊なコメント
code:php
/**
* ここに関数の説明を書く
*/
function foo() {}
code:php
/**
* ここにクラスの説明を書く
*/
class Hoge
{
/** @var Piyo 一行形式 */
private $member;
}
なぜ一行形式でも
//
ではなく
/** */
形式で書くのかというと、PhpStormなどで表示できるから。
https://gyazo.com/698de5a479f62d98ab480d821e19863d