1. まとめトップ

この記事は私がまとめました

Doctor.Yさん

はじめに:Doxygen(ドキシジェン)とは

Doxygen(ドキシジェン)は、C++、C言語、Java、Objective-C、Python、IDL(CORBAおよびマイクロソフト形式)のためのドキュメンテーションジェネレータである。他にも PHP、C#、D言語、ActionScript でもある程度利用可能。多くのUNIX系システム、Microsoft Windows、Mac OS X で動作する。

手順0:準備(CentOS6.3とPHPのインストール)

手順1:Doxygenのインストール

# yum -y install doxygen

手順2:graphvizなどのインストール

# yum -y install graphviz graphviz-gd

Graphviz(Graph Visualization Software)は AT&T研究所が開発したオープンソースのツールパッケージであり、DOT言語のスクリプトで示されたグラフを描画する。パッケージにはアプリケーションソフトウェアからツールを使うためのライブラリも含まれる。Graphviz は Common Public License ライセンスで提供されるフリーソフトウェアである。

手順3:Doxyfileの生成

Doxygenでドキュメントを生成したいプロジェクトフォルダの下に移動後

# doxygen -g

手順4:Doxyfileの編集

とりあえずこれくらいか?

PROJECT_NAME = "プロジェクト名を記入"

PROJECT_NUMBER = "プロジェクトナンバー(1.0.0)を記入"

# 日本語出力
OUTPUT_LANGUAGE = Japanese

# JavaDocスタイルコメント利用
JAVADOC_AUTOBRIEF = YES

# コメント付いていなくてもドキュメント化
EXTRACT_ALL = YES

EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES

# サブディレクトリまで検索してドキュメント生成
RECURSIVE = YES

GENERATE_LATEX = NO

#「dot」ツールでグラフィック表示
HAVE_DOT = YES

UML_LOOK = YES

CALL_GRAPH = YES

CALLER_GRAPH = YES

手順5:doxygenで出力されるようにソースにコメント付与

■メインページの記述
/**
* @mainpage メインページのタイトル
*
* @section セクションのタイトル
*
* セクションの説明
*
* @section セクションのタイトル
*
* @subsection サブセクションのタイトル
* etc...
*/

■関数には以下のように記述(必要なものだけ書けばOK)
/**
* 関数の概要を記入
* @author 作者
* @date 日付
* @version バージョン
* @note 注釈記述
* @param $a パラメータ$aのコメントを記入
* @return 関数の戻り値を記入
*/
function func($a, ・・・)
{
 ・・・
 return $b;
}

■ファイルには以下のように記述(必要なものだけ書けばOK)
/**
* @file
* ここから下は関数と同じ
*/

■クラスのプロパティーには以下のように記述
public $a; ///< $aのコメントを記入

手順6:ドキュメントの生成

手順7:ドキュメントの確認

htmlフォルダの中にドキュメントが作成されているで、

index.htmlをブラウザで見る

関連リンク

1