「phpunitの既存の関数にオリジナルのDocコメントをつけられるか?」に関しての考えをまとめました。

目次

assertionはどのような挙動をするか不明瞭なケースがある。特に導入初期においては、不明瞭さが導入の障壁となる。何をどのように書けば良いのかわからないコードは使われなくなる。悲しいけれど。。。

そこでDocコメントを日本語で明確にできないかと考えた。

結論から言うとできるが、まあベストプラクティスではないなあという感じ。

PHPUnitを親クラスに継承した独自クラスを作りDocコメントを書く。

// MyPHPUnit.php
class MyPHPUnit extends PHPUnit\Framework\TestCase {
    /**
     * Custom doc comment for assertEquals method.
     *
     * @param mixed $expected
     * @param mixed $actual
     * @param string $message = ''
     * @param float $delta = 0.0
     */
    public function assertMyEquals($expected, $actual, $message = '', $delta = 0.0) {
        // Custom implementation or call parent method
        parent::assertEquals($expected, $actual, $message, $delta);
    }
}