jbrandwood / liberis

MIT License
7 stars 2 forks source link

Documentation: Assembly-language functions need comments #16

Open dshadoff opened 3 months ago

dshadoff commented 3 months ago

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.