javaのソースコードの管理

Question

既存のjavaプロジェクトのソースコードの査読をしていますが、ソースファイルが膨大に有って管理しきれません。
更に、ディレクトリもやたら深いので、読みづらいです。
仕方なく、今読んでいるソースコードにブックマークをつけて、どのプロジェクトのソースなのか区別していますが、何かいい方法はありませんか？

エディタはEclipseを使用しています

Answer 1

自分的には、doxygenをオススメします。
他人のプロジェクトのソースを見る時には、まずdoxygenでドキュメントを作ってそれを見ます。

有名なツールなんで知っているかもしれませんが、一応説明。
doxygenは、ソースコードに決まった書式でコメントを書いておけば、それを読み取ってドキュメント化してくれるツールです。
更には、graphvizというツールと一緒に使えば、クラス図なども書いてくれます。
まぁ、元となったのはjavadocというツールらしいのですが。

使い方などは、ググってもらえばいくらでも出てくるので、そちらを見てもらうとして…。

先も言ったとおり、「決まった書式でコメントを書けば」ドキュメント化してくれますが、コメントを書いていないと大したドキュメントが作成されません。
そこで、以下の設定をします。

EXTRACT_ALL = YES
SOURCE_BROWSER = YES

まず、「EXTRACT_ALL = YES」で、コメントを書いていないクラス・メンバなど全てとりあえず出力してくれます。
もっとも、コメントが書かれていないので、説明とかは当然ありませんが。

そして、「SOURCE_BROWSER = YES」でソースコードをドキュメントから閲覧できるようにします。

これで、作成したHTMLドキュメントを開くと、シンタックスがハイライトされたソースコードを見る事ができます。
更には、クラス・メンバなどは全てそのドキュメントへのリンクが貼られています。

例えば、こんな感じです。(リンク先は、DBusというライブラリのドキュメントです)

先も言ったとおり意識してコメントを書かないとドキュメントとしては成り立ちませんが、ソースコード閲覧だけであればこれだけでも下手なテキストエディタより見やすくなると思います。

Comments

[退会済みユーザー]

ありがとうございます。
まだ、IT業界に入りたてで、初めて聞くツールですが、まずは試してみようと思います。
沢山の方が統一されていない方法で書いているのか、日本語英語のコメントが混じっており、かつ本番環境のサーバを動かすことができないので、デバックすら実行できない（デバック実行→メイン関数に入る→サーバが無いエラーログを出力→終了）。
文書もシーケンス図のみで泣きそうですが、教えていたツールで頑張ってみようと思います。

Answer 2

VSCode+Javaプラグインなど、高機能なエディタ環境を入れて、それで追っかけるなどしてみては。
使用してるキーワードやメソッドの、定義やコメントなどを簡単に参照できるようになったり、定義場所にジャンプできたりします

Comments

[退会済みユーザー]

ご回答ありがとうございます。
今日から、インストールして試してみます