phpUnit テスト docblock ではアノテーションを使用するのが通常である逆の規則が既にあり@coversます。
コードの一部を見ている場合、そのロジックを実行するテストを調べて、コードが何をすべきかを理解すると役立つことがよくあります。PHP では、関数を実行するために記述されたテストを見つける場所をコード内に文書化する規則はありますか? そうでない場合は、独自の規則を採用する予定であり、次のオプションのいずれかを検討しています。
- phpDocumentorアノテーションを使用する
@internal - のような完全にカスタムの注釈を使用します
@spec - docblock 内の単なるフリー コメントですが、すぐに認識できるパターンでスタイル設定されています
- 文書化しませんが、コードをコメントアウトしてテストされている場所を見つけ、テストスイートを実行して、どのテストが失敗するかを確認します。
これらの使用に対する警告はありますか?