Add PHPDoc so it is easier to develop with autocomplete

koolphp / koolreport

This is an Open Source PHP Reporting Framework which you can use to write perfect data reports or to construct awesome dashboards using PHP

https://www.koolreport.com/

MIT License

226 stars 66 forks source link

Add PHPDoc so it is easier to develop with autocomplete #10

Open sebathi opened 6 years ago

sebathi commented 6 years ago

Having PHPDoc will make the library easier to use on IDEs with autocomplete and inline help.

koolphp commented 6 years ago

That's a great idea. We will do that.

lkraav commented 5 years ago

Yes, agree very much. After PhpStorm, can't have anything less.

koolphp commented 5 years ago

Do you have any knowledge to setup this. Currently in latest version of KoolReport, we do add PHP Doc Block (following guideline of phpdoc) on each methods and properties but not sure how IDE is able to read them and provide intellisense. If you have any experience, please share!

lkraav commented 5 years ago

It's automatic, don't need to do anything specific. As long as you have great code linting in place via phpcs, phpmd etc, just make sure everything is documented in code and that you get build warnings when someone forgets.