上野家のホームページ
ナーマル，マリン，ココ
[
新規
|
一覧
|
検索
|
最新
|
ヘルプ
]
開発/doxygen
をテンプレートにして作成
資料室
開発/doxygen をテンプレートにして作成
[
差分
|
バックアップ
|
リロード
]
[ ]
開始行:
*Doxygenって
プログラムのソースコードを解析して，ドキュメントを作って...
ダウンロードは，http://www.doxygen.jp/から。
Doxygenには，次のような特徴がある。
-文書化されたソースファイルのセットから，オンライン・ドキ...
-文書化されていないソースファイルから，コードの構造を抽出...
-通常のドキュメントを作成することも出来る。（Doxygenのサ...
**あると便利なツール
-Graphviz~
Doxygenは，クラスダイアグラムを生成する機能を持っているの...
Doxygenをインストールする前に，これを入れておいたほうが良...
http://www.graphviz.org/ の[[Download:http://www.graphviz...
ダウンロードしたファイルをクリックしてインストールする。
-HTML Help Workshop~
MS製の，Doxygenが出力するドキュメントから，WindowsのHTML ...
ここの[[MSのサイト>http://www.microsoft.com/downloads/en/...
--Doxygenでchmファイルを作る時，追加する設定
GENERATE_HTMLHELP = YES
CHM_FILE = ../xxxxx.chm
HHC_LOCATION = "\"C:\Program Files\HTML Help W...
GENERATE_CHI = YES
CHM_INDEX_ENCODING = CP932
**Doxygenのインストール
Doxygenのサイトの右側にある[[Downloadするところ:http://ww...
これもクリックしてインストールする。~
PATHを通しておく必要があるので，短めのディレクトリのほう...
**doxygenの設定ファイル「Doxyfile」での設定
Doxygenを実行する時に，動作を設定するためのdoxyfileをその...
設定ファイルはDoxywizardっていうGUIツールで作成できる。一...
|Wizard|簡易設定。ウィザード形式で Project ～ Diagrams ま...
|Expert|高度な設定。Wizard より細かな設定をおこなえる。|
|Run|ドキュメント生成などを実行できる|
設定はWizardタブを開いて行う。~
''Project''
|Project name|プロジェクト名の設定。ドキュメントのタイト...
|Project synopsis|プロジェクト概要。出力形式がHTMLの場合...
|Project version or id|プロジェクトのバージョン情報，また...
|Project logo|プロジェクトのロゴとなる画像ファイル。出力...
|Select code directory|解析対象とするソースコードを格納し...
|Scan recursively|ソースコードのフォルダが階層化されてお...
|Destination directory|ドキュメントの出力先。未指定なら作...
''Mode''
|Select the desired extraction mode|解析対象。Documented ...
|Select programming language to optimize the result for|...
''Output''
|HTML|plain HTML|標準のHTMLを出力する。|
||with navigation panel|ページの左側にナビゲーションパネ...
||prepare for compressed HTML(.chm)|MS Compiled HTML Help...
||With search function|PHPの稼働しているWeb サーバーに配...
||Change color…|HTML出力する際の全体的な色を変更できる。...
|LaTeX|as intermediate format for hyperlinked PDF|LaTeX用...
||as intermediate format for PDF|LaTeX用の中間形式として...
||as intermediate format for PostScript|LaTeX用の中間形式...
|Man pages||UNIXのman（マニュアル）コマンド用ファイルを出...
|Rich Text Format(RTF)||リッチテキスト形式のファイルを出...
|XML||XML 形式のファイルを出力する。独自の出力形式が欲し...
''Diagrams''
|Diagram to generate|No diagrams|ダイアグラムを出力しない...
||Use built-in class diagram generator|Doxygenに内蔵され...
||Use dot tool from the GraphViz package to generate|Grap...
|Dot graphs to generate|Class diagrams|クラス図を作成する...
||Collaboration diagrams|コラボレーション図を作成する。|
||Include dependency graphs|インクルード依存グラフを作成...
||Include by dependency graphs|インクルード依存グラフを作...
||Call graphs|呼び出しグラフを作成する。これをチェックす...
||Called by graphs|間接的な呼び出しフラグを作成する。この...
''Expert''タブ
|Doxyfile Encodeing|設定ファイルDoxyfileのコードを設定す...
|OUTPUT_LANGUAGE|日本語で出力させるために，''Japanese''に...
|OPTIMIZE_OUTPUT_FOR_C|Cソースのみの場合は，YESにしておく...
|INPUT_ENCODING|入力ファイルの言語ローケールの設定。S-JIS...
|EXTRACT_PRIVATE|''YES''にすると，プライベートメンバーを...
|EXTRACT_LOCAL_CLASSES|''YES''で，ローカルクラスを文書に...
|SHOW_INCLUDE_FILES|''YES''で，インクルードファイルのリス...
すべての設定が完了したら，Runタブを開き，Run doxygenボタ...
''CHMファイル作成''
|GENERATE_HTMLHELP|チェックすることで，CHMファイルの出力...
|CHM_FILE|出力するファイル名。プロジェクト名.chm とするの...
|HHC_LOCATION|HTML Help Workshopの実行ファイルへのフルパ...
|CHM_INDEX_ENCODING|CHMファイルを開いた時，目次タブに表示...
DOXYFILE_ENCODING = UTF-8 # SJIS...
PROJECT_NAME = "XXXXXX PCB Firmware" # 適当に
PROJECT_NUMBER = 1.1.0 # 適当に
OUTPUT_LANGUAGE = Japanese # やっ...
HAVE_DOT = YES # Graph...
OUTPUT_DIRECTORY = # 出力...
TAB_SIZE = 8 # TAB幅
FILE_PATTERNS = *.cpp *.c *.h # 対象...
EXTRACT_PRIVATE = YES # priva...
その他，いっぱいオプションがある。''doxygen -g''とすると...
*Doxygenでの書き方と主なタグ
**2種のコメント
doxygenコメントには，「概要記述」と「詳細記述」の2つのコ...
|doxygenコメント|内容|書き方|h
|概要記述（brief description）| 詳細解説およびサマリーに...
|詳細記述（detailed description）|詳細解説の個所のみで利...
どちらもファイルの先頭，対象となる関数，構造体，C++のクラ...
図は，doxygenが出力するファイルのコメントの例です。doxyge...
#ref(サマリーと詳細.jpg)
**書き方
-サマリーの書き方~
/// サマリーだよ
とか，
//! サマリーだよ
''注意：サマリーを複数行に書いてしまうと，詳細説明になっ...
-詳細説明の書き方
QTスタイル
/*
* 詳細記述
* 詳細記述
*/
/*
詳細記述
詳細記述
*/
JavaDocスタイル~
/**
* 詳細記述
* 詳細記述
*/
/** 詳細記述 */
-詳細説明の中でサマリーを記述しちゃう方法~
詳細説明中にサマリーを書きたい場合は，「''@brief''」とい...
''@brief''を利用すると，空のコメント行までがサマリーとし...
/*!
* 詳細説明
* @brief サマリー説明
* 概要説明
*
* 詳細説明
*/
/*!
@brief 文字列の文字数を返す
@param [in] s 文字列
@return 文字数
*/
/*!
@brief 文字列での文字の位置を返す
@param [in] s 文字列
@retval 0 見つからなかった
@retval 0以外 文字の位置
*/
-補足説明を付けたい変数や関数の定義前に通常コメントを書く~
補足説明を付けたい変数や関数の定義前に通常コメントを書き...
doxygenのコメントは，このような後方コメントにも対応してお...
変数定義 /*!< 詳細説明 */
とか
変数定義 /*!< 詳細説明 */
や，
変数定義 ///< サマリーだよ
int globBase = 10; ///< 足し算用のパラメータ
とか
変数定義 //!< サマリーだよ
とかにします。
**文章の飾り付けとセクションコマンド
コメントの中では"スペシャルコマンド"や"HTMLコマンド"と呼...
|書き方|説明|h
|@bほげほげ|''ほげほげ''|
|＜b＞ほげほげ＜/b＞|''ほげほげ''|
|@emほげほげ|'''ほげほげ'''|
|<em>ほげほげ</em>|'''ほげほげ'''|
|@code～@endcode|コードブロック|
|@verbatim～@endverbatim|直接表記|
-@および\で始まる語は，doxygenコマンドとして解釈しようと...
<>&#%もHTMLで特殊な意味を持ちますので，エスケープする必要...
-空白行は，ブロック終了コマンドの無いブロックを終了させる...
-コメントされている識別子を文中に書くと，自動でリンクが張...
-コマンドには引数がある場合がある。コマンドの後ろに何か記...
-HTMLタグを使用すると出力に反映されるけど，プログラムのソ...
-単に改行しても出力されないので，ソース上の整形で単に改行...
|セクションコマンド|説明|h
|@mainpage|doxygenで作成されるドキュメントの最初のページ...
|@author|開発者名を記載する。|
|@deprecated|廃止されたクラスやメソッドであることを，記載...
|@param|関数の引数名と引数の概要（引数の数だけ記述）なん...
|@return|戻り値を記載する（戻り値がvoidの時は不要）|
|@retval|戻り値を記載する（戻り値がいくつかの値をとる場合...
|@arg / @li|箇条書き。- (インデントした行頭ハイフン) の場...
|@par|段落の開始。引数は，パラグラフタイトルになる。タイ...
|@see / @sa|参照すべき箇所や関連するクラスなんかを記載す...
|@code / @endcode|コードブロックの指定。この間のテキスト...
|@since|導入された日付なんかを記載する|
|@throw|関数なんかの例外を記載する|
|@version|バージョンを記載する|
|@note|覚書のような，メモなんかを記載する|
|@attention|注意書き。現在の使用時なんかでの注意点を記載...
|@warnning|警告書き。開発者なんかに，動作仕様からは判らな...
|@date|日付をつけて履歴なんかを記載するときに使う。複数書...
|@bug|バグ情報。リストとして一覧が出るので，@dateの代りに...
-PHPだとこんな感じ~
/**
* @brief etcクラスはその他のデータを表します。
*
* @author yuji
* @see labeledETC
* @date 2007/04/09
*/
class etc{
/**
* その他のデータを表す
* @note private String name
* @deprecated この値を直接操作することは推奨されませ...
*/
var $name;
/**
* 名前を設定
* @param name 名前を指定
* @note void setName(String name)
*/
function setName($name){
$this->name = $name;
}
/**
* 名前の取得
* @return String
* @note String getName()
*/
function getName(){
return $this->name;
}
}
終了行:
*Doxygenって
プログラムのソースコードを解析して，ドキュメントを作って...
ダウンロードは，http://www.doxygen.jp/から。
Doxygenには，次のような特徴がある。
-文書化されたソースファイルのセットから，オンライン・ドキ...
-文書化されていないソースファイルから，コードの構造を抽出...
-通常のドキュメントを作成することも出来る。（Doxygenのサ...
**あると便利なツール
-Graphviz~
Doxygenは，クラスダイアグラムを生成する機能を持っているの...
Doxygenをインストールする前に，これを入れておいたほうが良...
http://www.graphviz.org/ の[[Download:http://www.graphviz...
ダウンロードしたファイルをクリックしてインストールする。
-HTML Help Workshop~
MS製の，Doxygenが出力するドキュメントから，WindowsのHTML ...
ここの[[MSのサイト>http://www.microsoft.com/downloads/en/...
--Doxygenでchmファイルを作る時，追加する設定
GENERATE_HTMLHELP = YES
CHM_FILE = ../xxxxx.chm
HHC_LOCATION = "\"C:\Program Files\HTML Help W...
GENERATE_CHI = YES
CHM_INDEX_ENCODING = CP932
**Doxygenのインストール
Doxygenのサイトの右側にある[[Downloadするところ:http://ww...
これもクリックしてインストールする。~
PATHを通しておく必要があるので，短めのディレクトリのほう...
**doxygenの設定ファイル「Doxyfile」での設定
Doxygenを実行する時に，動作を設定するためのdoxyfileをその...
設定ファイルはDoxywizardっていうGUIツールで作成できる。一...
|Wizard|簡易設定。ウィザード形式で Project ～ Diagrams ま...
|Expert|高度な設定。Wizard より細かな設定をおこなえる。|
|Run|ドキュメント生成などを実行できる|
設定はWizardタブを開いて行う。~
''Project''
|Project name|プロジェクト名の設定。ドキュメントのタイト...
|Project synopsis|プロジェクト概要。出力形式がHTMLの場合...
|Project version or id|プロジェクトのバージョン情報，また...
|Project logo|プロジェクトのロゴとなる画像ファイル。出力...
|Select code directory|解析対象とするソースコードを格納し...
|Scan recursively|ソースコードのフォルダが階層化されてお...
|Destination directory|ドキュメントの出力先。未指定なら作...
''Mode''
|Select the desired extraction mode|解析対象。Documented ...
|Select programming language to optimize the result for|...
''Output''
|HTML|plain HTML|標準のHTMLを出力する。|
||with navigation panel|ページの左側にナビゲーションパネ...
||prepare for compressed HTML(.chm)|MS Compiled HTML Help...
||With search function|PHPの稼働しているWeb サーバーに配...
||Change color…|HTML出力する際の全体的な色を変更できる。...
|LaTeX|as intermediate format for hyperlinked PDF|LaTeX用...
||as intermediate format for PDF|LaTeX用の中間形式として...
||as intermediate format for PostScript|LaTeX用の中間形式...
|Man pages||UNIXのman（マニュアル）コマンド用ファイルを出...
|Rich Text Format(RTF)||リッチテキスト形式のファイルを出...
|XML||XML 形式のファイルを出力する。独自の出力形式が欲し...
''Diagrams''
|Diagram to generate|No diagrams|ダイアグラムを出力しない...
||Use built-in class diagram generator|Doxygenに内蔵され...
||Use dot tool from the GraphViz package to generate|Grap...
|Dot graphs to generate|Class diagrams|クラス図を作成する...
||Collaboration diagrams|コラボレーション図を作成する。|
||Include dependency graphs|インクルード依存グラフを作成...
||Include by dependency graphs|インクルード依存グラフを作...
||Call graphs|呼び出しグラフを作成する。これをチェックす...
||Called by graphs|間接的な呼び出しフラグを作成する。この...
''Expert''タブ
|Doxyfile Encodeing|設定ファイルDoxyfileのコードを設定す...
|OUTPUT_LANGUAGE|日本語で出力させるために，''Japanese''に...
|OPTIMIZE_OUTPUT_FOR_C|Cソースのみの場合は，YESにしておく...
|INPUT_ENCODING|入力ファイルの言語ローケールの設定。S-JIS...
|EXTRACT_PRIVATE|''YES''にすると，プライベートメンバーを...
|EXTRACT_LOCAL_CLASSES|''YES''で，ローカルクラスを文書に...
|SHOW_INCLUDE_FILES|''YES''で，インクルードファイルのリス...
すべての設定が完了したら，Runタブを開き，Run doxygenボタ...
''CHMファイル作成''
|GENERATE_HTMLHELP|チェックすることで，CHMファイルの出力...
|CHM_FILE|出力するファイル名。プロジェクト名.chm とするの...
|HHC_LOCATION|HTML Help Workshopの実行ファイルへのフルパ...
|CHM_INDEX_ENCODING|CHMファイルを開いた時，目次タブに表示...
DOXYFILE_ENCODING = UTF-8 # SJIS...
PROJECT_NAME = "XXXXXX PCB Firmware" # 適当に
PROJECT_NUMBER = 1.1.0 # 適当に
OUTPUT_LANGUAGE = Japanese # やっ...
HAVE_DOT = YES # Graph...
OUTPUT_DIRECTORY = # 出力...
TAB_SIZE = 8 # TAB幅
FILE_PATTERNS = *.cpp *.c *.h # 対象...
EXTRACT_PRIVATE = YES # priva...
その他，いっぱいオプションがある。''doxygen -g''とすると...
*Doxygenでの書き方と主なタグ
**2種のコメント
doxygenコメントには，「概要記述」と「詳細記述」の2つのコ...
|doxygenコメント|内容|書き方|h
|概要記述（brief description）| 詳細解説およびサマリーに...
|詳細記述（detailed description）|詳細解説の個所のみで利...
どちらもファイルの先頭，対象となる関数，構造体，C++のクラ...
図は，doxygenが出力するファイルのコメントの例です。doxyge...
#ref(サマリーと詳細.jpg)
**書き方
-サマリーの書き方~
/// サマリーだよ
とか，
//! サマリーだよ
''注意：サマリーを複数行に書いてしまうと，詳細説明になっ...
-詳細説明の書き方
QTスタイル
/*
* 詳細記述
* 詳細記述
*/
/*
詳細記述
詳細記述
*/
JavaDocスタイル~
/**
* 詳細記述
* 詳細記述
*/
/** 詳細記述 */
-詳細説明の中でサマリーを記述しちゃう方法~
詳細説明中にサマリーを書きたい場合は，「''@brief''」とい...
''@brief''を利用すると，空のコメント行までがサマリーとし...
/*!
* 詳細説明
* @brief サマリー説明
* 概要説明
*
* 詳細説明
*/
/*!
@brief 文字列の文字数を返す
@param [in] s 文字列
@return 文字数
*/
/*!
@brief 文字列での文字の位置を返す
@param [in] s 文字列
@retval 0 見つからなかった
@retval 0以外 文字の位置
*/
-補足説明を付けたい変数や関数の定義前に通常コメントを書く~
補足説明を付けたい変数や関数の定義前に通常コメントを書き...
doxygenのコメントは，このような後方コメントにも対応してお...
変数定義 /*!< 詳細説明 */
とか
変数定義 /*!< 詳細説明 */
や，
変数定義 ///< サマリーだよ
int globBase = 10; ///< 足し算用のパラメータ
とか
変数定義 //!< サマリーだよ
とかにします。
**文章の飾り付けとセクションコマンド
コメントの中では"スペシャルコマンド"や"HTMLコマンド"と呼...
|書き方|説明|h
|@bほげほげ|''ほげほげ''|
|＜b＞ほげほげ＜/b＞|''ほげほげ''|
|@emほげほげ|'''ほげほげ'''|
|<em>ほげほげ</em>|'''ほげほげ'''|
|@code～@endcode|コードブロック|
|@verbatim～@endverbatim|直接表記|
-@および\で始まる語は，doxygenコマンドとして解釈しようと...
<>&#%もHTMLで特殊な意味を持ちますので，エスケープする必要...
-空白行は，ブロック終了コマンドの無いブロックを終了させる...
-コメントされている識別子を文中に書くと，自動でリンクが張...
-コマンドには引数がある場合がある。コマンドの後ろに何か記...
-HTMLタグを使用すると出力に反映されるけど，プログラムのソ...
-単に改行しても出力されないので，ソース上の整形で単に改行...
|セクションコマンド|説明|h
|@mainpage|doxygenで作成されるドキュメントの最初のページ...
|@author|開発者名を記載する。|
|@deprecated|廃止されたクラスやメソッドであることを，記載...
|@param|関数の引数名と引数の概要（引数の数だけ記述）なん...
|@return|戻り値を記載する（戻り値がvoidの時は不要）|
|@retval|戻り値を記載する（戻り値がいくつかの値をとる場合...
|@arg / @li|箇条書き。- (インデントした行頭ハイフン) の場...
|@par|段落の開始。引数は，パラグラフタイトルになる。タイ...
|@see / @sa|参照すべき箇所や関連するクラスなんかを記載す...
|@code / @endcode|コードブロックの指定。この間のテキスト...
|@since|導入された日付なんかを記載する|
|@throw|関数なんかの例外を記載する|
|@version|バージョンを記載する|
|@note|覚書のような，メモなんかを記載する|
|@attention|注意書き。現在の使用時なんかでの注意点を記載...
|@warnning|警告書き。開発者なんかに，動作仕様からは判らな...
|@date|日付をつけて履歴なんかを記載するときに使う。複数書...
|@bug|バグ情報。リストとして一覧が出るので，@dateの代りに...
-PHPだとこんな感じ~
/**
* @brief etcクラスはその他のデータを表します。
*
* @author yuji
* @see labeledETC
* @date 2007/04/09
*/
class etc{
/**
* その他のデータを表す
* @note private String name
* @deprecated この値を直接操作することは推奨されませ...
*/
var $name;
/**
* 名前を設定
* @param name 名前を指定
* @note void setName(String name)
*/
function setName($name){
$this->name = $name;
}
/**
* 名前の取得
* @return String
* @note String getName()
*/
function getName(){
return $this->name;
}
}
ページ名:
Counter: 0, today: 0, yesterday: 0
Copyright©2008 Yuji Ueno All Rights Reserved.
ログイン
ユーザ名:
パスワード:
IDとパスワードを記憶
パスワード紛失
メインメニュー
ホーム
でぶlog
資料室
最新ページ一覧
全ページ一覧
ヘルプ
フォーラム
お問い合わせ
