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

split up or document long methods #73

Open
2 tasks
radumg opened this issue May 7, 2019 · 0 comments
Open
2 tasks

split up or document long methods #73

radumg opened this issue May 7, 2019 · 0 comments
Assignees
Labels
refactor Cleanup and refactor of existing solution.
Milestone

Comments

@radumg
Copy link
Collaborator

radumg commented May 7, 2019

When dealing with long methods (>30 lines of code), we should either

  • split up functionality into private util methods in that class, based on the distinct steps in the method
  • add // comments to document the distinct steps required, in plain English (the WHY, not just the WHAT code is doing).

Tasks

  • identify long methods & create task here for each
  • refactor them
@radumg radumg added the refactor Cleanup and refactor of existing solution. label May 7, 2019
@radumg radumg added this to the Code Quality milestone May 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactor Cleanup and refactor of existing solution.
Projects
None yet
Development

No branches or pull requests

2 participants