Notable PHP package: PHP Readme Helper

Recommend this page to a friend!
  Blog PHP Classes blog   RSS 1.0 feed RSS 2.0 feed   Blog Notable PHP package: ...   Post a comment Post a comment   See comments See comments (0)   Trackbacks (0)  

Author:

Updated on: 2020-06-13

Posted on: 2020-06-13

Viewers: 63 (June 2020)

Categories: Notable Packages

Many API developers produce documentation for their APIs in README files using the Markdown format.

This package can generate automatic documentation README files for APIs by extracting such documentations from API source files.

Read this article to learn more details about how this notable PHP package works.




The package PHP Readme Helper 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: API documentation generator for README files

Here follows in more detail what it does:

This package can be used as an API documentation generator for README files.

It can scan a given directory to find class files or check a given class file to extract documentation about the class functions and variables.

The package can generate a new README file from a template file in Markdown format and returns it as a string.

Optionally it can restrict the generated documentation to a given list of class functions.

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.



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

1,561,460 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.



  Blog PHP Classes blog   RSS 1.0 feed RSS 2.0 feed   Blog Notable PHP package: ...   Post a comment Post a comment   See comments See comments (0)   Trackbacks (0)  

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