2010-09-22 3 views
0

Как выполнять вызовы функций, задокументированные в php? Я хотел бы иметь что-то вроде:документация вызовов функций

= = = =

function_name1 (список аргументов)

описание функции

Foo бар (извлеченный из PHP -doc, как комментарии)

звонки:

function_name2 (список аргументов)

function_name3 (список аргументов)

называют в function4 function5

= = = = = = = = = = = =

имя_функции2 (список аргументов)

описание функции

Foo бар (извлеченный из PHP-документ, как комментарии)

звонки:

function_name5 (список аргументов)

является вызванный в

function1

..

+0

http: // stackoverflow.com/questions/3859791/php-cleanup-the-junk «Есть утилита, которая может отслеживать код PHP из основного index.php, чтобы я мог понять, что не используется и что есть, или я застрял делать ручную очистку? " – Cedric

+0

Я действительно забыл этот вопрос и задал аналогичный (но другой) один: http://stackoverflow.com/questions/4861107/reverse-engineer-phphtml-files-not-object-oriented-ones-to-produce- a-diagram – Cedric

ответ

0

Наиболее широко используется documentation standard in the PHP world is PHPDoc. Он получен из JavaDoc. Большое количество IDE поддерживают PHPDoc, что означает, что они могут автоматизировать документацию, и вы можете получить завершение кода и другие функции.

Существует несколько инструментов, позволяющих автогенерировать документацию из аннотаций кода PHPDoc. PhpDocumentor уже упоминалось в другом месте является наиболее заметным, но вы также можете использовать Doxygen, что позволяет использовать более широкий спектр форматов документации

Update: PhpDocumentor довольно устарела и не может правильно работать с PHP5.3 кодом (? Пытавшихся закрытий) , Существует (в настоящее время) две стоящие альтернативы: DocBlox и phpDox.

+0

спасибо! - doxygen очень полезен, имеет четкий отличный формат (однако он не документирует вызовы из функции, расположенной во включенном файле для PHP). – Cedric

Смежные вопросы