December 2, 2012

FuelPHPでphpDocumentor 2のドキュメントを作成する小物TaskをGitHubに置いておきました。

先に、phpDocumentor 2がインストールされている必要があります。
▼phpDocumentor 2のインストール手順(Mac/Win/Linux)
http://madroom-project.blogspot.jp/2012/12/phpdocumentor-2macwin.html

また、当Taskは、以下のTaskと姉妹的な感じで実装してあります。
▼FuelPHPでカバレッジレポートを作成する小物TaskをGitHubに置いておきました。
http://madroom-project.blogspot.jp/2012/11/fuelphptaskgithub.html

当Taskのソースは、以下になります。
https://github.com/mp-php/fuel-myapp/blob/master/tasks/phpdoc.php

php oil r phpdoc:htmlでhtmlのドキュメントが作成されます。
第一引数が除外するディレクトリ(デフォルトは"")
* 指定ディレクトリは第二引数からの相対パス
* カンマ区切りで複数ディレクトリを指定可能
第二引数が入力ディレクトリ(デフォルトは"fuel/app/classes/")
第三引数が出力ディレクトリ(デフォルトは"../docs/")
となります。
引数の順がちょっとおかしい気もしますが、個人的な省略の頻度から、とりあえずこの順番にしています。後々、変更するかもしれません。

第三引数のディレクトリに対して削除処理を行った後、ドキュメントを作成します。
第三引数のディレクトリが存在する場合、-fオプションを付与していないと即時終了します。

IDEの設定ファイル等をGIt管理から避ける為に、プロジェクトを以下の構成にしているので、デフォルトディレクトリも、workと並ぶようにしています。

--
プロジェクトルート/
    work/(ここをGit管理)
    xxx/
    yyy/
    docs/(今回のtaskで生成するディレクトリのデフォルト)
    その他、IDEの設定ファイル等
--

尚、php oil r phpdocとphp oil r phpdoc:helpでヘルプ表示です。


ドキュメントもちゃんと書いていきたい。

No comments:

Post a Comment