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.

Sign up for GitHub

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

Jump to bottom

Improve code comments #1

Open

apigeeks-lee opened this issue Jan 25, 2019 · 0 comments

Contributor

apigeeks-lee commented Jan 25, 2019

To avoid technical debt and share our knowledge across the team - we need to practice good documentation.

Please ensure that class has a preamble that describes the purpose of the class and high-level functionality.

Methods that are no-trivial should have a short comment outline their purpose and "business" logic that they encapsulate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment