phpDocについて

phpDocとは

phpDocumentor通称phpDocとは 関数やクラスなどを修飾する、特別な形態の範囲コメントです。クラスやメソッドの定義前にブロックコメントを決められた方式で記述していると、APIドキュメントを自動生成することができます。

phpDocの書き方

/** */で区切る 。それだけ

/**
 * ここにかく
 */

/** 一行にまとめてもよい */

/**
 * 複数行書く場合
 * 慣習として
 * 各行始めに * を書く
 */

参考になるサイト