Skip to content

Need code comments and docblocks #4

@Deathnerd

Description

@Deathnerd

This implementation was hurried through during my break from school during the summer. As such I have a whole TON of working knowledge on what the code does going on in my head but not actually in comments. Furthermore, the API relies on dynamic, hard to document option arrays. These need to be hinted with reasonable default values in the constructor/method signatures where ever possible. This will help where static analyzers such as PHPStorm's parameter hinting are available. Regardless of whether signature hints are in place, there must be detailed documentation in the method/constructor's DocBlock about the options that can be used in the array.

Metadata

Metadata

Assignees

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions