phpDoc使用入門
phpDoc使用入門
1.ダウンロード
にある http://sourceforge.net/projects/phpdocu/files/phpDocをダウンロードして、私のバージョンは1.4.3です
2.使用
解凍後、端末:phpdoc-h すべてのコマンドを表示し、重要なものをいくつか選択できます.
-d ソースphpファイルのパス
-t ドキュメントを生成した後のドキュメントの保存パス(フォルダを個別に作成することが望ましい)
-dn パッケージの名前(デフォルトはdefaultですが、プロジェクトの名前に変更したほうがいいです)
-dc ディレクトリの名前(デフォルトはdefaultですが、プロジェクトの名前に変更したほうがいいです)
-ti ドキュメントタイトル これはトップページの大見出しです
-o 生成されたドキュメントのテンプレートフォーマットは、これはいろいろな選択肢があるはずですが、私はHTML:Smarty:PHP(美しい感じ)だけを選択します.
3.
注釈ルール(javadoc、doxygen、jsdocなど、ほとんどのドキュメント生成ツールとは異なります)
次の部分はネットワークから整理されています.
注意:phpDocは他の自動ドキュメント生成ツールとは異なり、コメントにhtmlコードを追加することはできません.
1.
各phpファイルの先頭:
次はphpDocの正規化コメントです.
4.文書の生成:
仕様の注釈が作成されました.次に、ドキュメントを本当に生成します.
例:
phpdoc -d ./a -t ./b -dn abc -dc def -ti xyz -o HTML:Smarty:PHP
上の意味は./aのphpファイルのためにドキュメントを生成し、./bディレクトリの下に保存し、パッケージ名はabc、ディレクトリ名はdef、タイトルはxyzで、HTML:Smarty:PHPをテンプレートとします.
5.問題:
ドキュメントを生成する場合、タイムゾーンが設定されていないため、生成後のドキュメントに次のwarningが表示されます.
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'Asia/Chongqing' for 'CST/8.0/no DST' instead in/home/hutao/phpDocumentor/Files/PhpDocumentor-1.4.3/PhpDocumentor-1.4.3/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
解決策:
warningプロンプトでSmartyを開くCompiler.class.phpファイルを2行目(1行目はdate_default_timezone_set('Asia/Shanghai'); //'Asia/Shanghai' アジア/上海
手動でタイムゾーンを選択することを示します
そしてさらに4ステップ目のコマンドを実行すればいいのです～～～～
完了!
1.ダウンロード
にある http://sourceforge.net/projects/phpdocu/files/phpDocをダウンロードして、私のバージョンは1.4.3です
2.使用
解凍後、端末:phpdoc-h すべてのコマンドを表示し、重要なものをいくつか選択できます.
-d ソースphpファイルのパス
-t ドキュメントを生成した後のドキュメントの保存パス(フォルダを個別に作成することが望ましい)
-dn パッケージの名前(デフォルトはdefaultですが、プロジェクトの名前に変更したほうがいいです)
-dc ディレクトリの名前(デフォルトはdefaultですが、プロジェクトの名前に変更したほうがいいです)
-ti ドキュメントタイトル これはトップページの大見出しです
-o 生成されたドキュメントのテンプレートフォーマットは、これはいろいろな選択肢があるはずですが、私はHTML:Smarty:PHP(美しい感じ)だけを選択します.
3.
注釈ルール(javadoc、doxygen、jsdocなど、ほとんどのドキュメント生成ツールとは異なります)
次の部分はネットワークから整理されています.
注意:phpDocは他の自動ドキュメント生成ツールとは異なり、コメントにhtmlコードを追加することはできません.
1.
各phpファイルの先頭:
/**
* Common base class of all phpdoc classes （ ， ， ）
*
* As a kind of common base class PhpdocObject holds
* configuration values (e.g. error handling) and debugging
* methods (e.g. introspection()). It does not have a constructor,
* so you can always inheritig Phpdoc classes from this
* class without any trouble. （ ， ）
*
* @author Ulf Wendel
* @version $Id: PhpdocObject.php,v 1.3 2001/02/18 15:29:29 uw Exp $
* @package PHPDoc （ ）（ package ， * ， ）
*/次はphpDocの正規化コメントです.
4.文書の生成:
仕様の注釈が作成されました.次に、ドキュメントを本当に生成します.
例:
phpdoc -d ./a -t ./b -dn abc -dc def -ti xyz -o HTML:Smarty:PHP
上の意味は./aのphpファイルのためにドキュメントを生成し、./bディレクトリの下に保存し、パッケージ名はabc、ディレクトリ名はdef、タイトルはxyzで、HTML:Smarty:PHPをテンプレートとします.
5.問題:
ドキュメントを生成する場合、タイムゾーンが設定されていないため、生成後のドキュメントに次のwarningが表示されます.
Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected 'Asia/Chongqing' for 'CST/8.0/no DST' instead in/home/hutao/phpDocumentor/Files/PhpDocumentor-1.4.3/PhpDocumentor-1.4.3/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
解決策:
warningプロンプトでSmartyを開くCompiler.class.phpファイルを2行目(1行目はdate_default_timezone_set('Asia/Shanghai'); //'Asia/Shanghai' アジア/上海
手動でタイムゾーンを選択することを示します
そしてさらに4ステップ目のコマンドを実行すればいいのです～～～～
完了!