PHPDocの書き方を学ぶ
概要 phpDocumentorとはクラスやメソッドの定義前にブロックコメントを決められた方式で記述していると、APIドキュメントを自動生成することができるツール 今回はそのphpDocumentorで記述する書式についてまとめる PHPDocの書き方 前提知識 DocCommentの開始は以下のように記述する ※ 開始行のアスタリスクは必ず2つ /** * @var int */ $num = rand(0, 10); 1行で記述することもできる /** @var int */ $num = rand(0, 10); 「//」を使ったコメントではDocCommentにはならにことに注意 PHPDocを記述する例 ファイルの先頭 目的など簡潔に記述する <?php /** * このファイルではPHPDocの説明をします * * @copyright 会社名 All Rights Reser
最低限書いておきたいPHPのDocコメント - Qiita
最低限書いておきたいというよりは、最低限書いて下さいという私の切なる願いかもしれない。 そもそも何故Docコメントを書くのだろうか？ メソッドの命名さえ正確に行えるならDocコメントという存在はほぼ必要無いという考えがあり、 それは間違いでは無いでだろう。 しかし… 型が無いためにメソッド名を冗長にしてしまう 以下のコードは税率を取得するだけの単純なものだ。 TAX::getRate()と実行することで税率を取得出来る。 これなら、主語＝TAX、述語＝getRateと読み取れるので何をしているのか一目瞭然である。 class Tax { private static $tax_rate = 0.8; public static function getRate() { return self::$tax_rate; } } しかし、これは戻ってくる値の型を予約出来る静的片付け言語であればの
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
