Skip to content

Documentation: Assembly-language functions need comments #16

Description

@dshadoff

All assembly-language functions should have comments for readability/support purposes:

Minimally:

  1. To define the inputs and outputs of functions (and relevant data types).
  2. To explain any "magic numbers" used in the code.

And on more complex functions:

  1. To give an overview/description of how the function is implemented, so that flow can be followed easily.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions