PHPDocumentorでAPIドキュメントを作成しよう！
PHPでプログラミングをされている皆さんはどんな形でドキュメントを残されていますか？
そもそもドキュメントなんか作成せずにいきなりコーディング！って方法が一番多い気がします。僕も今まで関わった案件（まだ１年ですけど）にドキュメントなんて無いに等しい状態でしたから。
ただドキュメントが無いと後で改修を行う場合、修正箇所がわからなくなっていることが多いので、ソースにある程度コメントを残す習慣がついてきます。
PHPDocumentorはjavadocの様に指定のフォーマットで書かれたコメントを元にAPIドキュメントを作成してくれるすばらしいライブラリです。（コメントの書き方は次回にでもｗ）PEARで配布されている為、インストールも
pear install phpdocumentor
で簡単にインストールできます（PEARコマンドが使えることが前提）
また、最新のバージョンでは、出力形式をHTMLやChm、PDFと様々な形式に出力させることができます。ただ、PDFの場合、日本語が文字化けしてしまうのですが・・・
PHPで開発を行っている方は、後々の改修作業・引継ぎ作業の為にもPHPDocumentorでドキュメントを作成しておくことをお勧めします！
次回はコメントに書き方について書きます。
ブログランキング参加中。ご協力お願いします。
PHPでRSSパーサーを！ ≪ [前の記事]
WiNDy ONLINE（旧SOLDAM ONLINE）でセールしてます ≫ [次の記事]
トラックバック(0)
このブログ記事を参照しているブログ一覧: PHPDocumentorでAPIドキュメントを作成しよう！
このブログ記事に対するトラックバックURL: http://www.chrysaor.org/mt/mt-tb.cgi/5
コメントする