Skip to content

ソースコードのみから設計の意図を読み取るのは難しい

IROF edited this page Dec 16, 2021 · 4 revisions

現代のIDEにはソースツリー表示、エディタ部分のシンタックスハイライトを伴うソースコード表示、定義へジャンプ、呼び出し元を検索といったソースコードを読み解く助けとなる多くの機能がそろっています。

2020-12-06_14h48_21

しかしこういったIDEの機能を使ったとしても、何万行、何十万行もあるソースコードのみを読み進めながら設計の意図を把握するのは困難です。読み進めているうちに自分が何を理解しようとしていたのか見失ってしまうことは、大規模なソースコードでは珍しくありません。とくに開発チームに新たに加入したメンバーが独力でソースコードを読み解こうとするのは困難が伴います。

大規模なソースコードを読み解く際に、全体の設計を把握していれば理解が早くなりますが、JIGのドキュメントはこういった設計の意図を俯瞰的に把握するのに最適です。アーキテクチャ図サービスメソッド呼び出し図はアプリケーション全体の設計を把握するのに役立ちましし、パッケージ関連図ビジネスルール一覧ビジネスルール関連図ビジネスルールの設計を可視化してくれます。これら以外にもJIGには設計情報を俯瞰的な視点から見通しやすくしてくれるドキュメントが揃っています。

自分一人でJIGドキュメントを見ながら設計を読み取るばかりでなく、自分が行った設計の意図を他人に説明する際にも有用です。レビューリファクタリングなど他の開発者に設計の意図を説明するときに、JIGのドキュメントが大きな助けになってくれるでしょう。

狙い・背景・思想

付録

JIGの設定と他ツールとの統合

JIGの利用シナリオ

JIGが提供しないもの

その他

参考リンク 🔗

Clone this wiki locally