Documentation testsの恩恵

トラック2

LT

17:20~17:40

ドキュメンテーションテストとは何者か、どのような恩恵があるのか、TypeScriptでどのように実践するのかを紹介します。 TypeScriptのソースコードをテストする方法は数多ありますが、ドキュメンテーションテストについて言及、実践している方は非常に少ないと思います。ドキュメンテーションテストは、その名の通りドキュメントとしてもテストとしても機能します。「型チェックなどの静的テスト」と「単体テスト」では受けられない恩恵を紹介します。 ドキュメンテーションテストは、名前の通りドキュメントとしてテストを記述します。これにより主に以下3点の恩恵が受けられます。 ・ドキュメントに書かれたコードが正常に動作すること ・ドキュメントが管理されず動かない例を見たことがあると思います ・IDEでサンプルコードが閲覧しやすくなること ・ドキュメントを書く習慣の定着及び、ドキュメントに対する心理的障壁の緩和

ssssota_image
ssssota

エンジニア

気の向くままにコードを書いている。

github_linktwitter_link