Skip to content

Improve code comments #1

@apigeeks-lee

Description

@apigeeks-lee

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions