PHP APIGEN

[beniston]

What is APIGEN? Its a library which helps us generate documentation. This is alternative or preferred one over PhpDocumentor because PhpDocumentor has stopped its growth and lacks in modernism.

Here when I said documentation, I meant API documentation (Technical)

In short, we have to comment the code with the APIGEN rules and with the single command we can generate documentation for the whole project.

Here is an article which helps you understand more about APIGEN: http://phpmaster.com/generate-documenta ... th-apigen/

[beniston]

[jay]

Thanks Beniston. It is great to go through the example and it is much helpful to the programmers in knowing what it is all about even after years.

Is there anyway by which it can be helpful to the designers/Pm's as well?

[beniston]

Not sure about how it would benefit the designers. But it would be of great help to the Team Leads and PMs because they can easily do the following:

* Do code review.
* Understand the technical aspect of how each method and property mean for the requirement.
* They can easily explain to resources what each of them means, even if they don't know the programming language.
* They don't have to go to the repository to look into the code.
* They can look into the code without disturbing the code.

It may take little more time with coding in-order to implement it. But it's work the time developers spend on it.