1. How to Improve Your PHP Project Documentation by Finding Source Files with Missing or Wrong PHPDoc Comments
Updated on: 2020-12-06
Posted on: 2020-12-06
Having good documentation is important for any project as it helps remembering all relevant aspects of how to use the programming components that are well documented.
A common practice among PHP developers is to use PHPDoc comments to store attributes about the different sections of a component like classes, functions, variables.
On a complex project it is hard to have all relevant components well documented.
This package simplifies the process of producing complete documentation of projects with multiple components, as it can scan code files to find which components are missing documentation in PHPDoc format, or even find mistakes in existing PHPDoc comments.
More ... Post a comment See comments (0) Trackbacks (0)
A common practice among PHP developers is to use PHPDoc comments to store attributes about the different sections of a component like classes, functions, variables.
On a complex project it is hard to have all relevant components well documented.
This package simplifies the process of producing complete documentation of projects with multiple components, as it can scan code files to find which components are missing documentation in PHPDoc format, or even find mistakes in existing PHPDoc comments.
More ... Post a comment See comments (0) Trackbacks (0)