How to Improve Your PHP Project Documentation by Finding Source Files with Missing or Wrong PHPDoc Comments - PHP Doctor package blog

Recommend this page to a friend!
  All package blogs All package blogs   PHP Doctor PHP Doctor   Blog PHP Doctor package blog   RSS 1.0 feed RSS 2.0 feed   Blog How to Improve Your P...  
  Post a comment Post a comment   See comments See comments (0)   Trackbacks (0)  

Author:

Updated on: 2020-12-06

Posted on: 2020-12-06

Viewers: 90 (December 2020)

Package: PHP Doctor

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.




About the PHP Doctor Package

The package PHP Doctor is one of the few PHP packages that was considered notable recently because it does something that is worth paying attention.

The basic purpose is: Scan PHP to find missing or wrong PHPDoc comments

Here follows in more detail what it does:

This package can scan PHP to find missing or wrong PHPDoc comments.

It can scan a given string with PHP code or a PHP script file or all PHP script files in a given directory.

The package returns all the documentation errors that it finds in the scanned code.

Conclusion

The PHP Doctor can be downloaded from download page or be installed using the PHP Composer tool following instructions in the Composer install instructions page.

This package was considered notable for implementing its benefits in a way that is worth noticing.

Notable PHP packages can be often considered innovative. If this package is also innovative, it can be nominated to the PHP Innovation Award and the author may win prizes and recognition for sharing innovative packages.

If you also developed your own notable or innovative packages consider sharing them, so you can also earn more visibility for your package as well nice prizes.

One nice prize that many PHP developers want and you may like is the PHP elePHPant mascot plush.




You need to be a registered user or login to post a comment

1,569,983 PHP developers registered to the PHP Classes site.
Be One of Us!

Login Immediately with your account on:

FacebookGmail
HotmailStackOverflow
GitHubYahoo


Comments:

No comments were submitted yet.



  Post a comment Post a comment   See comments See comments (0)   Trackbacks (0)  
  All package blogs All package blogs   PHP Doctor PHP Doctor   Blog PHP Doctor package blog   RSS 1.0 feed RSS 2.0 feed   Blog How to Improve Your P...  

For more information send a message to info at phpclasses dot org.