Lack of commenting within source code
navitronic opened this issue · comments
Adrian Palmer commented
Any plans to add in PHPDoc style documentation to the source code to give some idea of an API for the various classes?
marcoarment commented
Possibly, with a big caveat: documentation should be added thoughtfully, not just with a huge 10-line formatted comment above every little method regardless of how obvious it is.
The function and variable names should serve as most of the documentation, only adding PHPDoc-style blocks when truly necessary — and even then, maybe the better solution is to rename or refactor the functions or variables to be more obvious.