Diary?

2008-12-15
Mon

(22:20)

Java のコードスタイルチェックツールの Checkstyle を導入してるプロジェクトは多いと思うけど、これ気をつけないと完全にアンチパターン物だよな。具体的には、規約の改訂にきちんと同期してメンテナンスして行かないとダメって事。これを怠ると Checkstyle の警告ばかりでて、本来の警告が見過ごされがちになっちまうからな。特にカスタムルールまで作り込んでる現場はそのリスクがより大きい。

そういう状況を防ぐには

  • コーディング規約のドキュメントは自動生成
  • 生成の元ネタは Checkstyle のルールとカスタムルールの Javadoc
  • Javadoc には必ず成功例と失敗例を載せて、何らかの形で doctest のようなものを実装する
  • そして当然デイリービルドの対象にする

ぐらいやれば効果あるかなあと思うけど、ここまでリソース割けるんだったらそもそも Checkstyle などのツールのメンテナンス要員が足りないなんてことにはならねーよな。

Creative Commons
この怪文書はクリエイティブ・コモンズ・ライセンスの元でライセンスされています。引用した文章など Kuwata Chikara に著作権のないものについては、それらの著作権保持者に帰属します。