最近はphpDocumentor等なるべく資料は自動生成もので済まそうとしているのですが、MySQL用の自動ドキュメント生成ツールを見つけたので紹介。一応XML/HTML/TXT形式での出力が可能ですが見た目的に印刷向きではないようです。XML形式が使えるので整形ツールを別に作成すれば凄いことができそうです。
mysqldocはPerlで書かれた単体のプログラムで下記のモジュールが必要です。
またテストされた環境は配布サイトによるとMySQL5.0とFreeBSDだそうですが、とりあえずfedora7で問題なく動いてます。
使い方は--helpに対応しているのでそれを見たほうが早いのですが、ドキュメントは標準出力されるのでリダイレクトしてファイルに書き込んでください。
例)
./mysqldoc \
--databases=データベース名 \
--host=サーバのIPアドレス \
--port=ポート番号 \
--user=DBユーザ名\
--output=[XML|HTML|TXT]から選択 > 出力先
phpMyAdminで印刷用出力が出来るから必須ではないかな…。
参考：mysqldoc - Google Code
http://code.google.com/p/mysqldoc/
記事：moongift » MySQLのドキュメント作成「mysqldoc」オープンソースを毎日紹介
http://www.moongift.jp/2008/04/mysqldoc/
コメントする