ApiGenを使ってドキュメントを作成してみた

スポンサーリンク

過去に書いた記事 phpDocumentorでソースファイルからドキュメントを作成してみた とは別のツールを使ってみたドキュメントを作成してみました。

今回はApiGenというツールを発見したのでこのツールを使ってドキュメントの生成をしてみました。

ApiGen公式サイト:http://www.apigen.org/
インストール方法:https://github.com/apigen/apigen

下記コマンドでapigen.phar*をインストール。

$ curl -sS http://apigen.org/installer | php

インストールしたら今度はapigen.neon というneonフォーマットのファイルを作成。
neonファイルジェネレーター:http://ne-on.org/

このneonフォーマットのファイルが設定ファイルになります。
私は下記のように設定してジェネレートしました。

#解析するソース(フォルダー名を指定)
source:
	- junaio-php-helper-library

#テンプレートファイルを指定(githubにいくつかテンプレートファイルあり)
templateConfig: /xxx/config.neon
#解析結果出力ファイルの保存先(フォルダー名を指定)
destination: api
#解析サイトタイトル
title: API ドキュメント

準備ができたら下記コマンドでドキュメントの生成を開始。

php apigen.phar generate

apigen.neonで指定した、destinationのフォルダー内に解析結果が出力されているかどうか確認。
体感ですが、phpDocumentorより生成速度は早い感じがしました。

スポンサーリンク
スポンサーリンク
スポンサーリンク

フォローする

スポンサーリンク
スポンサーリンク