phpDocumentor用コメントの書き方 - phpspot
phpDocumentor 用というわけではありませんが、こういう感じにコメントを書きましょう、というのがあります。 関数/メソッドの場合 例えば、 function hoge($arg,$arg2){} という関数があったとして、 第一引数の型が 文字列型、$arg2 の型が 整数型だった場合で、戻り値が配列型であった場合、コメントは、 /** * hogeの説明 * * @param string $arg 第一引数 * @param integer $arg2 第二引数 * @return array 戻り値の説明 */ のようになります。 型として、string や integer のほかに、object(オブジェクト), array, mixed(いろんな型が返る場合), resource(リソース型) といったものが使えます。 オブジェクトのメソッドの場合は、アクセス修飾子とし
【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ページを開く
