JAM LOG

これは何？

W3C構文チェッカーで限りなくパーフェクトな結果を得ることを目標に書いたphpDocumentor用のSmartyテンプレートです。本家サイトで配布されているSmartyテンプレート「PHP」を改良し、テーブルレイアウトを排除して完全CSSレイアウトによるXHTML1.0 Strictで書き直しました。

インストール方法

下記のように、PEARディレクトリの「data」内にあるSmary用テンプレート「PHP」と差し替えて使用します。

/path/to/pear
 /data/PhpDocumentor/phpDocumentor
  /Converters/HTML/Smarty
   /templates/
    /PHP/

オリジナルの入手はこちら。(↓)

phpDocumentor: Documentation Choices

サンプルはこちら。(↓)

LOGGiX API Documentation

おまけ：phpDocumentorのインストール方法と簡単な使い方

Terminalから、

$ sudo pear install phpdocumentor

とインストールすればインストールOKです。

使い方はAPIドキュメント化したいあなたのPHPクラスファイル群がはいっているディレクトリにTerminalで移動し(↓)

$ cd /あなたのPHPファイルディレクトリ/

以下のようにターゲットディレクトリと出力先ディレクトリとタイトルを指定して(↓)

$ phpdoc \\
-t ./出力先/ \\
-d ./あなたのPHPファイルディレクトリ/ \\
-ti 'あなたのAPIドキュメントタイトル' \\
-o HTML:Smarty:PHP \\
-pp

リターンキーで実行され、「出力先」にドキュメントが生成されます。

このphpDocumentorの使い方はTerminalを使ってのコマンドを覚える必要があるので最初の取っ掛かりが少し敷居が高いですが、一度方法に慣れるとこれほど簡単にAPIドキュメントが作れるのかと驚くほど楽になるのでPHPで何かしらコードを書いている全ての人にお薦め出来ます。

関連URI

1. JAM LOG : phpDocumentor
2. Do You PHP? - phpDocumentor - PHPDocに代わるAPIドキュメント自動生成ツール
3. PEAR :: Manual :: サンプルファイル (標準の Docblock コメントを含む)

KEdit PHP定義ファイルの説明とChangeLog

CotEditor PHP定義ファイルの説明とChangeLog