タグ

ブックマーク / qiita.com/motoyan-qwt (1)

  • 最低限書いておきたい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; } } しかし、これは戻ってくる値の型を予約出来る静的片付け言語であればの

    最低限書いておきたいPHPのDocコメント - Qiita
    at_yasu
    at_yasu 2015/06/12
    /** このコメントではこの実装を説明するには少なすぎる */とか書いてみたい。
  • 1