駄猫の備忘録

Intellij IDEA で少しだけPHPを書くのが楽になる方法

IDE使うならやっぱりバリバリに補完が効くほうが良いですよね？

ということでPHPをIDEAで書くときに補完がよく効くようになる方法

結論

コメントを書く

具体的に

class Hoge
{
    /**
     * @return Fuga
     */
    public function createFuga()
    {
        return new Fuga();
    }
}

class Fuga
{
    /**
     * @var Piyo
     */
    private $piyo;
    
    public function __construct()
    {
        $this->piyo = new Piyo();
    }
    
    /**
     * @return Piyo
     */
    public function getPiyo()
    {
        return $this->piyo;
    }
    
}

class Piyo
{
...

みたいに書くだけ

そうすると下記のような状況で補完が効いて幸せになれます

$hoge = new Hoge();

// ここは別に何もしなくてもHogeのメソッドは補完の一覧に出てくる
$fuga = $hoge->createFuga();

// Hoge::createFuga に@returnコメントがないと
// 下記のようなコードを書く際に補完が効かない（getPiyoが一覧に出てこない）
$piyo = $fuga->getPiyo();

@return / @var 重要

Unitテスト書くときに少し幸せ

class HogeTest extends PHPUnit_Framework_TestCase
{
    public function testHoge()
    {
        $mock = $this->createMock();
        ...
    }
    
    /**
     * @return Hoge|PHPUnit_Framework_MockObject_MockObject
     */
    public function createMock()
    {
        return $this->getMock("Hoge", ...
    }
}

まあなんか上記の例は @depends を使ったほうが良いケースの場合もあると思うので書き方は臨機応変に…

1メソッドの中で、Mock作っちゃうとPHPUnit_Framework_MockObject_MockObjectとしてしか認識しないので、当然Mock元のインスタンスメソッドとかは補完の対象として出てこないです。

上のようにあえて分離しといて@returnの内容を「|」で繋ぐと少し幸せになります

問題点

arrayとかの場合は全く幸せにならない
幸せになるのはIntellij とか PHPStomeとかでPHP書く人だけっぽい
てか微妙に苦労するくらいなら端から別の言語で…

まさか「IDEAで楽したいから@return書け、絶対！」とか言えませんよね？

ってことでチーム内で強要（？）する場合は

PHPCS/MD に怒られないように丁寧にコード書こうね！
コメントはちゃんとココらへん見て書こうね！

とかすればいいんじゃないでしょうか。

まあゴミのような引き継ぎ案件でそれを途中から入れるのは無理だろうけど

なので新規なのにPHPを書かなければならない可哀想な方々、導入時に静的解析ツールを入れましょう

まあ新規案件でPHPを選ぶとかあるのか…？

	import org.specs2._

	class LtsvSpec extends Specification {
	def is =
	"TDDBC 2013-03-16 Tokyo".title ^
	"""
	LTSVを読み込むクラスを作る
	今回 @akuraru さんとペアになって短時間で考えた結果
	基本的にMapでKey/Valueを保持し
	Keyの順番に関してはListで管理することにした
	"""^ p^
	"LTSV一行を管理するクラス" ^
	p^
	"key value をsetする場合" ^ set^
	"keyを指定して値を取得する場合" ^ get^
	"dumpメソッドで出力する場合" ^ dump^
	end

	def set =
	"key/valueを与えるとMapとListが更新される" ! pending ^
	"既に保有するキーの場合は、Mapのvalueが更新され、" +
	"Listで管理するkeyの順序は更新するキーが最後尾に来る" ! pending ^
	"正常系ならEither::Right(None)が返る" ! pending ^
	"正常系且つ更新ならEither::Right(Some(古いvalue))が返る" ! pending ^
	"keyがnullの場合はLeft" ! pending ^
	"keyが空文字はLeft" ! pending ^
	"valueがnullはLeft" ! pending ^
	"valueは空文字はOK(Right)" ! pending ^
	endp

	def get =
	"keyが存在すればSome(value)が返る" ! pending ^
	"keyが存在しなければNoneが返る" ! pending ^
	endp

	def dump =
	"dumpは tab区切り末尾改行のLTSVで出力する" ! pending ^
	endp
	}

駄猫の備忘録

2013年3月19日火曜日

#TDDBC Tokyo 2013-03 に参加してきました

2013年3月10日日曜日

Intellij IDEA で少しだけPHPを書くのが楽になるかもしれない方法

Intellij IDEA で少しだけPHPを書くのが楽になる方法

結論

具体的に

Unitテスト書くときに少し幸せ

問題点