[B! PHP] fossilcatのブックマーク

phpDocumentor

目次 1 phpDocumentorのインストール 1-1 パッケージの入手 1-2 インストール (Unix/Linux) 1-3 実行 1-4 その他補足 2 使い方 2-1 phpdocコマンドの実行 2-2 コメントの記入について・基本・定数のコメント・ @author ・ @global 2-3 タグについて・ @link ・ @package ・ @param ・ @return ・ @see ・ @subpackage ・ @var 2-4 インラインのタグについて・ @link 2-5 ちょっとしたメモ・対象ファイル拡張子の設定 PHPスクリプトに埋め込んだコメントから、ドキュメントページ（HTML)を生成してくれるツールです。自分でせこせことWordとかにまとめるよりもラクですし、何よりコメントとして記述もされるわけですから見直すときも参照しなくても

fossilcat 2010/11/27

PHP
phpdoc

リンク

phpDocumentor - phpspot

プログラムでドキュメントを書くのって面倒ですよね。そこで javadoc 風なドキュメントを作成してくれる phpDocumentor の紹介です。スクリプト中に /** * 概要 * phpDocumentorのサンプルです * * 説明 * phpDocumentorによって作成されました。 * * @param string $arg 説明 * * @return string 説明 */ function PACKAGE_fooFunc(){ } のような感じでコメントを書いておけばドキュメント化してくれます。 phpDocumentor用コメントの書き方インストール phpDocumentor は pear でもインストールできますが、今回は本家からファイルをダウンロードして進めます。まず、ここからダウンロードします。解凍すると、のようにファイルが沢山できます。 (