![]() ![]() It uses bootstrap and is responsive out of the box. ![]() But, the project has gotten new life and a 2.0 version is on the way. I used to treat it like I did with compile steps and go do something else while the documentation generated. The old version of phpDocumentor was slow. When the new features came to PHP I was forced to look elsewhere. I used to think phpDocumentor was a dead project. I look forward to a 1.0 release and to see where it can go from here. Of all the documentation tools for the PHP community this one might have the brightest future. Pretty graphs of the dependency chains.This was an addition to other tools I didn’t know I needed but has learn to really appreciate. It would be great to write docblocks with markdown and documentation pages in markdown. This exists in other tools and is something I’m finding useful. Maybe an introduction page to the API, some tutorials, etc. It would be great if you could write documentation pages as well as a code.There are some things I wish It could do: Especially if you already use modern PHP projects like this.Įach of these applications has strengths and weaknesses. Can generate documentation for multiple versions of a codebase using Git tags and branches for the versions.Modern in its look (the code), development, and interaction with other libraries.Significantly faster than phpDocumentor 1 was. For being a PHP CLI application it was fairly fast at generating PHP API documentation for the HPCloud PHP library generating the documentation in under a second. Most of what powers it is other libraries managed by Composer. The first commit was just two months ago (May 2012) and looks like the modern flavor of new PHP applications. Sami is literally the new kid on the block. The state of things has changed in recent times which is why I’m looking at the options again. Doxygen ended up being the tool I landed with. I used to be a fan or phpDocuemtor but when it fell into a stale state for an extended period I looked for alternatives. To let everyone know of my background up front, I’ve been using Doxygen for years. Let’s dive into these documentation tools. Doxygen: A multi-platform API documentation tool that supports PHP.phpDocumentor: What used to be the go to tool is starting to see new life in a 2.0 rewritten version.Sami: A recent addition to the documentation game and used to power the Symfony API documentation.The crop of documentation tools currently on my radar are: Our PHP libraries and applications should be well documented if we want others to be able to work with them (this includes team mates). When I recently started getting serious about documentation I wanted to understand the state of PHP documentation tools. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |