「わかりやすさ」をサポートする環境作り@Java開発

ここ数日、仕事で現在携わっているJava Webアプリの改修で、そんなに詳しく知っている訳では無い、他人が作った機能を結構広範囲で修正、テストする必要性に迫られました。


ざっくり機能全体のソースを追っていたんですけど、改行やスペースの使い方、適切なコメントの記述等幾つかのポイントで読み辛さ・把握のしにくさが目に付き、多少ストレスが溜まる溜まる…(@; ̄〜 ̄)


時間もあまり無いので直すかどうか迷ったけど、後の事を考えて結局見やすく整形してしまいました。



自分で書いたソースコードを、他人がぱっと見ても同じレベルで理解出来るとは限らないし。
また、自分の書いたものでも、数ヶ月、又は年単位で見直す時には内容忘れてるかもしれないし。


ある程度のソースコードの記述方法は個人の裁量に任せても構わないと思うけど、一定のレベルでの読みやすさ、理解のしやすさは確保して欲しいもんですね。


個人的に進めようと思ってる開発プロジェクでは、この辺のチェックやサポートをしっかりするようにしようと思います。(ぱっと思いつくのはCheckStyleFindBugsとか)

主に、EclipseプラグインやAntビルド等の形で実現する事になると思いますが後の為にメモ。

プラグイン - EclipseWiki
@IT > Java Solution > CoolなEclipseプラグイン