ドキュメント生成ツールのお
話
本間翔太
目次
•
•
•
•
•

自己紹介
ドキュメント生成ツールって何?
メリットとデメリット
導入するやり方
使ってみての感想
自己紹介
こんな人
• 萌えが好きで中二病な22歳
• IT高度専門学科4年
• C++とC#を主に使う、主にコードを書く
人
• DirectX11触り始めました!(白目)
• 勉強会の主催な気がする
• さすがミクちゃんだぜ…!!
• ブログやってます「マジカル
ドキュメント生成ツールって
何?
ドキュメント生成ツールって
何?

• こんなの作れる
ドキュメント生成ツールって
何?
• リファレンス生成ツール
• DirectX,PhysXのドキュメントのアレ
• 2種類ある事を私は知っている。

–Sandcastle
–Doxygen 今回はこっち
ドキュメント生成ツールって
何?

• Doxygen?
• LaTex ,HTML, RTF, XML, (chm) で出力可能
• クラス図,参照関係を自動出力可能

• ソースコードを含めて出力可能
• ドキュメント用のDoxygenタグ有り
ドキュメント生成ツールって
何?
• とりあえず生成してみる
ソースコード

HTML
chm
Let’s Doxygen!!
メリットとデメ
リット
メリット
メリット
• 他人に理解してもらう時に効果的。
– 膨大なソースコード、直接見せるの…?
– 作品提出の時に付属すると美味い気がする
デメリッ
ト
デメリット
• コメント書くの…面倒くさい…な…
• 自分だけが使う分にはメリットが薄い
導入するやり方
導入するやり方
例によって、ブログに書いた!!!
制作が始まる前に準備しておくといいかも!!

URL : http://bit.ly/1gcNTKv
使ってみての感想
• ゲームを作って終わり。の分には効果薄
い。
– でも、そのゲームを就活で提出する時が来るか
も。

• ライブラリとか作る時に必要なのでは

• いわゆる大規模開発の時に使うものなので
は
Let’s Doxygen!!
このスライドはピアプロ・キャラクター・ライセンスに基
づいて
クリプトン・フューチャー・メディア株式会社のキャラク

ドキュメント生成ツールのお話