cheka.jp 超不定期で更新する写真達。お口直しにどうぞ。

JenkinsでPHPの継続的インテグレーションを体験する ドキュメント生成編

PHPDocumentorを利用するとコード内のコメントをドキュメントとして出力することが可能です。
コメントの記述方法にはルールがありますが、チーム間で共有すると共通のフォーマットでドキュメントが出力されるので利用する価値は大きいでしょう。

PHPDocumentorはversion2を利用しますので、事前にインストールして下さい。

sudo pear install phpdoc/phpDocumentor-alpha

ではさっそく設定してみましょう。

ジョブの作成

インストールしたPHPDocumentorをjenkinsと連携させる為にジョブを作成する必要があります。
さっそくジョブを登録してみましょう。

新規登録

ジョブ名をphpdocで新規登録します。
タイプは「フリースタイル・プロジェクトのビルド」を選択して下さい。

新規ジョブ作成

ビルド手順の追加でphpdocを起動するスクリプトを追加します。

cd ${WORKSPACE} && sudo phpdoc --template=responsive -t _report/doc/ -i assets/*,commands/*,config/*,runtime/*,tests/*,vendor/*,views/*,web/* -d . || id
ビルド手順の追加

ビルド完了後に./_report/doc/へドキュメントが出力されるのでjavadocの保存でドキュメントを保存します。

_report/doc/
ビルド後の処理の追加

ジョブの実行

設定が完了したらジョブを実行してみましょう。
ジョブのメニューからビルドを実行して下さい。

ビルド実行

実行中のプログレッシバーが表示されます。
しばらく待ちましょう。

実行中

ビルドが正常に完了するとドキュメントの参照が可能になります。

ドキュメント確認

綺麗なレポートが出力できるように積極的にコメントを書きたくなりますね!

API Documentation

Add a Comment

メールアドレスが公開されることはありません。

Get Adobe Flash player