レイアウトにあまり標準ではないコードベースを持っているので、自家製の自動化されたドキュメントを作成しています。PHPファイルを読み込んでコメントブロックの内容を取得するのが最善の方法であると思っていました。私が考えることができる唯一の方法は、ファイルを開いて行単位で読むことですが、Reflection関数と同様に、ドキュメントを解析する組み込みの魔法がいくつかあると考えました。PHPでコメントブロックを読むには?
各ファイルの基本的なレイアウトは、このようなものです:
<?php // $Id$
/**
* Here is this script's documentation, with information in pseudo-javadoc
* type tags and whatnot.
*
* @attr something some information about something
* @attr etc etc etc
*/
// rest of the code goes here.
それは、これらのファイルは、その中で定義された任意の関数やクラスを持っていないことに注意することが重要です。コメントは、スクリプト全体に関連しています。
適用されます。反射関数は、関数、クラス、オブジェクトなどにのみ適用されるようです。解析するファイルを渡すことはできますか? – nickf
+1 phpDocumentor、特にそのコードがすでにフォーマッタである場合。 – jmucchiello