Erste Seite Zurück Weiter Letzte Seite Grafik
Documentation - Comments
Kinds of Comments:
- repeat of the code
- restates what the code does in different words
- more to read but no additional information (useless)
- explanations of the code
- explains complicated, tricky or sensitive pieces of the code
- in that case they are helpful
- but: if your code is so complicated try to make it clearer and use summary comments
markers in the code
- not intended to be left in the code
- mark portions of the code to be improved or not yet done
- use preprocessor directives (#warning, #error)