$shibayu36->blog;最近書いているWebアプリは、HTTPリクエストを送ってレスポンスと状態をテストする、というテストだけ書くようにしてる。リクエストするとブログエントリを返す、というサービスだとこういう風なテストを書いてる。endend言語化したことなかったけどこういう慣習があると思う。itに与える文字列は三人称単数系で始める正常系にタグを付けるこれまで色々な規則性を持たせてテストを書くことを試してきたけど、他のは進化の過程で淘汰されて、最終的にこの慣習が最も長く生き残った。ドキュメント形式でのテストの出力結果を見ると大体仕様が分かって便利、という側面もあるけど、このテストを実行すると謎の技術でAPIドキュメントがMarkdownで生成されるようになっているというのが良いところだと思う。全てこの規則の上に成り立っている。正常系用のタグが付いているテストケースごとに、次の情報が記載される。documentationみたいページを用意してあって、アクセスするとこのMarkdownファイルをいい感じに表示するようにしてる。テストを書くとドキュメントが生成されるので、テストを書くことに対する見返りが大きい。coverageは99.0%ぐらいあった気がする。今のところこの方法で困っていることが特に無いのだけど、敢えて言うなら仕様バグみたいなものが見つからないので、関心の埒外の出来事が起きて爆発する可能性がある。テストの出力結果を睨みながら、この仕様はおかしい、ということに人間が思い至る必要がある。API用にドキュメントを自動生成する実装があるので良かったら参考にどうぞ。https://github.com/r7kamura/autodoc。