PHPのコメント

2017.6.15 (木)
/**
 * [区分]クラスの概要
 *
 * クラスの詳細
 * 出来るだけ細かく書いたほうがよいが、詳細な説明は各メソッドに任せる。
 * 全体での共通ルールとか仕様を書く。
 *
 * @access アクセスレベル
 * @author 名前 <メールアドレス>
 * @copyright 会社名 All Rights Reserved
 * @category カテゴリー(処理系)
 * @package パッケージ(MVC)
 */
/**
 * [API]メッセージ送信系APIコントローラークラス
 *
 * メッセージ送信に関するAPIをまとめたコントローラークラス。
 * エンドポイント単位でメソッドを定義する。
 *
 * @access public
 * @author itosho <hogehoge@example.com>
 * @copyright  hogehoge Corporation All Rights Reserved
 * @category Message
 * @package Controller
 */
/**
 *  [区分]関数の概要
 *
 *  関数の詳細
 *  出来るかぎり細かく書く!でもシンプルに!(難しい)
 *
 * @access アクセスレベル
 * @param 型 パラメーター名(物理名) パラメーター型名(論理名)
 * @return 型 戻り値(物理名) 戻り値(論理名)
 * @see 関連(呼び出したり)する関数
 * @throws 例外についての記述
 * @todo 未対応(改善)事項等
 */
/**
 * [POST]メッセージ送信APIのコントローラー関数
 *
 * 即時送信の場合は、実際にメッセージ送信処理を行う。
 * 予約送信の場合は、メッセージの登録処理のみを行う。
 *
 * @access public
 * @see MessageApi::paramCheck
 * @throws NotFoundException メッセージがない場合は404エラーを返す
 */

http://qiita.com/itosho/items/0f809e067a9e4a41515e