Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
sebathi opened this issue Apr 9, 2018 · 4 comments
Open

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

sebathi opened this issue Apr 9, 2018 · 4 comments

Comments

@sebathi
Copy link

sebathi commented Apr 9, 2018

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

@koolphp
Copy link
Owner

koolphp commented Apr 9, 2018

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

@lkraav
Copy link

lkraav commented Nov 28, 2018

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

@koolphp
Copy link
Owner

koolphp commented Nov 29, 2018

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
Copy link

lkraav commented Nov 29, 2018

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants