documentation of function calls [closed]

Closed. This question is opinion-based. It is not currently accepting answers.

---

Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.

Closed 5 years ago.

Improve this qu开发者_JAVA百科estion

How to have the function calls documented in php ? I would like to have something like :

= = = =

function_name1(list of args)

description of the function

foo bar (extracted from php-doc like comments)

calls:

function_name2(list of args)

function_name3(list of args)

is called in function4 function5

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

function_name2(list of args)

description of the function

foo bar (extracted from php-doc like comments)

calls:

function_name5(list of args)

is called in

function1

..

---

Have a look at PhpDocumentor

---

The most widely used documentation standard in the PHP world is PHPDoc. It is derived from JavaDoc. A large number of IDEs support PHPDoc, which means they can automate documentation and you can gain code completion and other features from it.

Several tools exist to autogenerate documentation from PHPDoc code annotations. PHPdocumentor already mentioned elsewhere is the most prominent, but you can also use Doxygen which allows for a wider range of documentation formats

Update: phpDocumentor is quite outdated and cannot properly work with PHP5.3 code (tried closures?). There is (currently) two worthwhile alternatives to look at: DocBlox and phpDox.

---

Take a look at http://manual.phpdoc.org/HTMLframesConverter/DOM/default