Welcome to the complete documentation for phpDocumentor.
With these tutorials, guides and references we try to provide you with all the information that you need to optimally document your code and leverage phpDocumentor to generate an extensive set of documentation for your application.
The documentation is divided into 5 sections,
Documenting source code comes with quite a bit of lingo and specific terms; because it can be hard to remember them all there is also a 用語集 that aims to explains all concepts. Throughout this documentation we continuously refer to it, to help you comprehend everything that phpDocumentor has to offer.
phpDocumentor is the de-facto API Documentation Generator for PHP since the year 2000.
phpDocumentor 2 is a tool with which it is possible to generate documentation from your PHP source code. With this documentation you can provide your consumers with more information regarding the functionality embedded within your source and not only what is usable to them from your user interface.
Documentation generated by phpDocumentor 2 does not aim to be a replacement for conventional documentation but is rather supplemental, or reference, documentation.
This documention can prove to be very useful in the following, example, situations:
The phpDocumentor project has the following goal:
“Provide PHP Developers with all the tools and resources necessary to write effective and comprehensive documentation with as little effort possible.”
It tries to achieve this goal by: