Skip to main content

Code documentation

To document code we need to have in mind that we are doing it for other persons. We mainly have two ways of doing it:

  1. Comments
  2. Manuals

Comments

This type of documentation relies inside the code itself and should be used to represent ideas that the code itself can't provide, related to the underneath code.

Manuals