One IT Thing

IT業界を楽しむ為の学習系雑記

java

Doxygenでspring-frameworkをドキュメント化

投稿日:2019年8月2日 更新日:

以前にspring-frameworkのソースリーディングが出来る環境をOpenGrokで作りました。

読んでいる最中にクラス関連や呼び出しをビジュアルに把握したくなったりするので、Doxygenを使って補足資料として生成しておきます。

実行環境

  • CentOS 7.6
  • Doxygen 1.8.5
  • graphviz 2.30.1-21

doxygen、graphvizインストール

# yum -y install doxygen
# yum -y install graphviz graphviz-gd

doxygenコマンド、graphvizのdotコマンドがインストールされたことを確認します。

# doxygen -v
1.8.5

# dot -v
dot - graphviz version 2.30.1 (20180420.1509)

Doxyfileを設定

doxygenでドキュメント生成する際はDoxyfileというファイルを作成します。最近のバージョンではdoxywizardコマンドでGUI設定出来たりしますが、ターミナル操作の想定でコマンドラインのみで設定していきます。

/tmpにspring-frameworkをgit cloneしてある状態です。

# cd /tmp
# git clone https://github.com/spring-projects/spring-framework.git
# cd spring-framework

Doxyfileを生成します。

]# doxygen -g


Configuration file `Doxyfile' created.

Now edit the configuration file and enter

  doxygen Doxyfile

to generate the documentation for your project

vi Doxyfile等で以下の箇所を変更してJavaプロジェクト向けの生成設定を行います。

PROJECT_NAME = "プロジェクト名"
PROJECT_NUMBER = "1.0.0などのバージョン"
OUTPUT_LANGUAGE = Japanese
JAVADOC_AUTOBRIEF = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
RECURSIVE = YES
HAVE_DOT = YES
UML_LOOK = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
OPTIMIZE_OUTPUT_JAVA   = YES

ドキュメント生成開始

Doxyfileがあるディレクトリでdoxygenコマンドを実行するだけです。

# dogygen

生成された「html」ディレクトリをApacheなら/var/www/html/spring-frameworkなどにコピーして外部から参照出来るようにしておきます。

見れるか確認

http://HTTPサーバIP/spring-frameworkにブラウザでアクセスします。

クラス図。

コラボレーション図。

まとめ

ビジュアルなドキュメントが出来上がりました。

ソースリーディングのお供、他にも新規参画したプロジェクトの分析に使えますね。

-java
-,

執筆者:

関連記事

優秀なJava開発者になる為の10のステップ

プログラミングで生計を立てるなら企業ニーズの多いJavaはリターンの多い言語ですから使えるようになっておいて損はありません。 Javaはこの先まだまだ隆盛を誇るでしょうから、優秀なJava開発者になれ …

Maven環境別ビルド時、プロファイルの違いでdependencyを変える

MavenのResourceFilteringを使い、production、staging、developmentとかで環境別ビルドしている時、ある環境ビルドの時だけ特定のライブラリを追加する、をmv …

JavaでRSA暗号を使う際にCRYPTREC暗号リストに足元をすくわれる可能性を回避する

標準的な暗号しか使わないケースでもJavaでRSAを使う時はBouncyCastleを入れておいた方が無難、という話です。 “ECB”という文字列がプログラム中にあると監査に引 …

JavaとPerlでTCPソケット通信

目次1 はじめに2 対象読者3 実装3.1 TCPサーバ(Perl)3.2 TCPクライアント(Java)3.3 実行4 まとめ はじめに 前回の続きです。 One IT ThingJava …

Maven依存ライブラリのライセンスサマリを出す

Mavenで依存しているライブラリのライセンス累計を作成します。下記のように「ライセンス名 ライブラリ個数」の行がライセンス種別数分作られるイメージ。 BSD 4ASL2 43MIT 5 開発中のクロ …


shingo nakanishi。東京で消耗中の職歴20年越え中年ITエンジニアです。「生涯現役プログラマを楽しむ」ことができる働き方探しをライフワークにしています。

19歳(1996年)から書き始めた個人日記が5,000日を超え、残りの人生は発信をして行きたいと思い、令和元日からこのサイトを開始しました。勉強と試行錯誤をしながら、自分が経験したIT関連情報を投稿しています。