- 追加された行はこの色です。
- 削除された行はこの色です。
[[Open棟梁Project>http://opentouryo.osscons.jp/]] - [[マイクロソフト系技術情報 Wiki>http://techinfoofmicrosofttech.osscons.jp/]]
「[[マイクロソフト系技術情報 Wiki>http://techinfoofmicrosofttech.osscons.jp/]]」は、「[[Open棟梁Project>https://github.com/OpenTouryoProject/]]」,「[[OSSコンソーシアム .NET開発基盤部会>https://www.osscons.jp/dotNetDevelopmentInfrastructure/]]」によって運営されています。
-[[戻る>開発ツール]]
-戻る
--[[開発ツール]]
--[[ドキュメンテーション]]
* 目次 [#hdf6293a]
#contents
*参考 [#s74049af]
-[[開発ツール > ドキュメント>開発ツール#a5eac2fd]]
*概要 [#x3215fc3]
ドキュメンテーション・ツールは、大きく分けて、
*Doxygen [#a6a52b2e]
**概要 [#c6945769]
-[[納品、保守用のマニュアル生成>#s4b078ac]]~
クラス・メソッド構成とコードコメントから納品用マニュアルを生成する系のツール
-Doxygenは、フリーのソースコードからのドキュメント生成ツールです。
-[[モジュール、プログラム構造の把握用>#f718e7a1]]~
グラフィカルビュー、メトリクス、プロジェクトレポートなどを生成する系のツール
-Doxygenは、プログラムの構造とコメントを元に、ドキュメント生成します。
しか、この世に無いのが現状（仕様書をリバースで生成してくれたりはしない）。
-さらに、Graphvizというツールを組み合わせて使うことで、~
クラスや関数、ファイルの関係を図にして表示することが可能です。
*納品、保守用のマニュアル生成 [#s4b078ac]
クラス・メソッド構成とコードコメントから納品用マニュアルを生成する系のツール
-Java、C、C++、C++/CLI、C#、PHP、Fortranなどに対応しています。
**[[Doxygen]] [#a6a52b2e]
**A HotDocument [#q5569f1b]
***概要 [#h8e22833]
**入手方法 [#t65fe8cc]
以下からダウンロードして下さい。
こちらを確認ください。
-Doxygen配布サイト
--http://www.doxygen.jp/
--http://www.stack.nl/~dimitri/doxygen/download.html
-VB,VC++,C#,Java,Accessドキュメント自動生成ツール【A HotDocument】~
http://www.hotdocument.net/
--【A HotDocument】とは~
http://www.hotdocument.net/main/about.html
--ドキュメント自動作成ツールスイート【A Hot Document】 Studio2.0~
http://www.hotdocument.net/studio/studio20.html
-Graphviz配布サイト
--http://www.graphviz.org/
--http://www.graphviz.org/Download.php
***マニュアル [#ob6e98f1]
-コメント規約(コーディング規約)~
http://www.hotdocument.net/faq/man.html
**手順 [#m976a75f]
***サンプル [#x2cfc61c]
-ドキュメントギャラリー~
http://www.hotdocument.net/gallery/
-ドキュメント出力サンプルのダウンロード~
http://www.hotdocument.net/main/downfile.html
***インストール [#u67e687e]
いずれもデフォルトのインストールで問題ありません。
*モジュール、プログラム構造の把握用 [#f718e7a1]
グラフィカルビュー、メトリクス、プロジェクトレポートなどを生成する系のツール
***設定ファイルを開く [#t75d37da]
**[[Doxygen]] [#gda85e8f]
コールグラフも生成可能。
+添付のZIPをダウンロードして任意のフォルダに解凍します。~
&ref(doxygen.zip);
**Visustin [#j80b63b5]
-メソッド レベルのフローチャート（パッド、アクティビティ図相当）を出力できる。
+Doxygenを起動し、[File]メニューの[Open]を選択します。
+\doxygen\work内の任意の設定ファイルを開きます。
-下図がこのVisustinを使用して出力したフローチャート（パッド、アクティビティ図相当）
--プログラム設計レベルのフローチャートと、詳細設計レベルのフローチャートでは、~
条件分岐数に大きな違いか見られる（プログラム設計レベルのフローチャートの方が、条件分岐数が多くなる）
***設定を行う [#g7d85085]
+Doxygenの[Wizard]タブの設定を行います。
++project：Project name、Project version or id
+Doxygenの[Expert]タブの設定を行います。
++Input：INPUT_ENCODING
--プログラムからリバースしたフローチャートを一見して、詳細設計内容を理解することは難しい。
***ソースを配置する [#d38bed33]
+\doxygen\Code以下のフォルダにソースファイルを配置します。
++CPPフォルダ：C,C++,VC++
++Javaフォルダ：Java
++CSフォルダ：C#
--プログラマによっては、母体理解に、プログラムそのものを見たほうが、効率が良い可能性がある。
***ドキュメントを出力する [#s88470ce]
+Doxygenの[Run]タブの[Run doxygen]ボタンを押下します。
+\doxygen\outフォルダ以下に結果が出力されます。
#ref(Visustin.png,left,nowrap,Visustin)
**その他 [#j6a8b55a]
***設定 [#l08aa169]
-設定は、以下のタブから行います。
--[Wizard]タブ
--[Expert]タブ
-[Expert]タブがconfigurationのフルセットになっています。
**Understand [#we934638]
-設定値を確認するには、~
[Run]タブの[Show configuration]ボタンを押下して下さい。
***概要 [#t6d1afd5]
大規模なプログラムや複雑なプログラムをすばやく理解するための~
さまざまな機能を搭載したソースコード解析ツール。
-設定の保存
++Doxygenを起動し、[File]メニューの[Save]・[Save as...]を選択します。
***参考 [#u3be08e3]
-ソースコード解析ツール Understand | ソフトウェア品質保証 | テクマトリックス株式会社~
https://www.techmatrix.co.jp/product/understand/index.html
--機能紹介~
https://www.techmatrix.co.jp/product/understand/function/index.html
---グラフィカルビュー
---ソースコードの検索
---メトリクス
---エンティティの情報
---エディター
---プロジェクトレポート
---その他の機能
***マニュアル [#q51bebdc]
詳しくは以下のサイトを参照下さい。
--稼動環境~
https://www.techmatrix.co.jp/product/understand/requirement.html
---対象言語~
Ada, Assembly, C/C++, Objective-C/C++, C#, VB.NET, COBOL, FORTRAN,~
JOVIAL, Java, Pascal, PL/M, Python, VHDL, Web (PHP, HTML, CSS, JavaScript)~
※ C/C++, Objective-C/C++, C#, VB.NET, COBOL, Java, Python, Webがテクニカルサポートの対象。
-Doxygen Manual Overview~
http://www.stack.nl/~dimitri/doxygen/manual/index.html
-Understand - ソースコード構造解析ツール~
http://understand.techmatrix.jp
-Doxygen Manual Configuration~
http://www.stack.nl/~dimitri/doxygen/manual/config.html
-Understand Blog~
http://understand-jp.blogspot.jp
--ユースケース~
http://understand-jp.blogspot.jp/search/label/ユースケース
---デッドコードを検出する~
http://understand-jp.blogspot.jp/2016/09/blog-post.html
***サンプル [#l3e85823]
以下のサイトはDoxygenで生成したドキュメントのサンプルです。
-wordpress~
http://onlineconsultant.jp/doxygen/wordpress-2.8.4-ja/
-zen-cart~
http://onlineconsultant.jp/doxygen/zen-cart-1.3.0.2-jp/
-コードの複雑度も一目で分かり技術的負債を解消：~
100万行のソースコードを約2分で解析して快適な~
開発環境を実現するプロも納得の構造解析ツールとは - ＠IT~
http://www.atmarkit.co.jp/ait/articles/1504/08/news002.html
**FAQ [#b22936e8]
-doc形式で出力できないか？
--DoxgenでRTF形式で出力し、Wordで参照することが可能です。
**ChangeMiner [#vb947a5e]
-JavaDocのHTMLのイメージを変えずに doc形式で出力できないか？
--DocFlexというツールで、JavaDocのイメージを崩さないでRTF形式で出力できそうです。
***概要 [#m36f35ae]
企業の複雑なアプリケーションを可視化してインサイト情報を提供する影響分析ソリューション
--参考
---DocFlex-Javadoc - Basic Templates~
http://www.filigris.com/products/docflex_javadoc/templates/javadoc/#output.rtf~
http://www.filigris.com/products/docflex_javadoc/templates/javadoc/templates.php#PlainDoc.tpl
***参考 [#a6bdac0a]
-www.gtone.co.kr/jpn/main/ag/ag.php~
http://www.gtone.co.kr/jpn/main/ag/ag.php
--ライセンス(Limited Free / 30-day license )に問題が有るようなら、~
PDFDoclet(LGPL)も考えられる（未評価）。
-ChangeMiner - 企業アプリケーション統合分析ソリューション | GTONE |~
http://www.gtone.co.kr/products/cm_jp/index.html
--参考
---PDFDoclet - PDFDoclet~
http://pdfdoclet.sourceforge.net/
---MORIWAKI.NETのメモ帳 - JavaDocをPDFで出力~
http://moriwaki.net/cms/?p=527
-アプリケーション可視化ソリューション~
ChangeMiner（チェンジマイナー）| eSECTOR（イーセクター）~
https://www.esector.co.jp/product/changeminer/changeminer.html
-ローカル変数を出力したい。
--出来ないようなので、メソッド内コメントでの対応を検討下さい。
--メソッド内コメントでの対応も一般的な解決策であるようです。
--/*! ～コメント～ */でメソッド中コメントを記述可能。
--主な機能
---ダッシュボード + 統計
---高級検索
---構造 ＋ 関連関係分析
---フロー分析
---変更履歴管理
---ドキュメント自動作成
---データ系譜分析（オプション）
---コード品質及びセキュリティ脆弱性分析（オプション）
--参考
---Doxygen user discussions and queries~
http://blog.gmane.org/gmane.text.doxygen.general/month=20030601
---objective c - Documenting variables with Doxygen in C - Stack Overflow~
http://stackoverflow.com/questions/2064871/documenting-variables-with-doxygen-in-c
---sourceforge.net Doxygen doxygen-users~
http://sourceforge.net/mailarchive/forum.php?thread_name=8a7570670801251331s3e31a95ei6aac29789dc13a5a%40mail.gmail.com&forum_name=doxygen-users
---日本語情報は少ないので、
Googleで「Doxygen local variables」を
キーワードにして検索してみて下さい。
--サポート
---言語~
Java, JSP, XML, Java Script, Objective C, C#.Net, VB.NET, ASP, PHP, PERL, Visual Basic,~
PowerBuilder, Delphi, ANSI C/C++, Pro*C, Amdocs C, PL/1, RPG, Visual Gen, COBOL:ZOS, MF, HITACHI, ILE
---データベース
---フレームワーク
---JOBスケジューラ
---EAI
---その他
-VC++で結果が正しく表示されない。
--__declspecのキーワードで解析エラーが起きるようです。
--以下のプリプロセッサ設定が必要になるようです。
---ENABLE_PREPROCESSING = YES
---MACRO_EXPANSION = YES
---EXPAND_ONLY_PREDEF = YES
---PREDEFINED = __declspec(x)=
--アプリケーション自動分析 ChangeMiner~
http://changeminer.esector.co.jp
--参考
---Bug 323561 ? No Doxygen template comments for extern C void myFunc(int param)~
https://bugs.eclipse.org/bugs/show_bug.cgi?id=323561
---Doxygen~
http://www.stack.nl/~dimitri/doxygen/preprocessing.html
----
Tags: [[.NET開発]], [[:ツール類]], [[:ドキュメンテーション]]
*A HotDocument [#q5569f1b]
**概要 [#h8e22833]
こちらを確認ください。
-VB,VC++,C#,Java,Accessドキュメント自動生成ツール【A HotDocument】~
http://www.hotdocument.net/
--【A HotDocument】とは~
http://www.hotdocument.net/main/about.html
--ドキュメント自動作成ツールスイート【A Hot Document】 Studio2.0~
http://www.hotdocument.net/studio/studio20.html
**その他 [#w55b74ea]
***マニュアル [#ob6e98f1]
-コメント規約(コーディング規約)~
http://www.hotdocument.net/faq/man.html
***サンプル [#x2cfc61c]
-ドキュメントギャラリー~
http://www.hotdocument.net/gallery/
-ドキュメント出力サンプルのダウンロード~
http://www.hotdocument.net/main/downfile.html
![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
