Documentation - RWTH-EBC/AixOCAT GitHub Wiki

Note, that without a good documentation, your code is very likely to be unreadable even for yourself in a year from now. So spend some time on documentation, as long as you still have an idea, what your code is doing.

General Description

You can add a general description with a comment above the declaration line of your library object. The general description of library objects is displayed in the Documentation tab of the Library Manager. Further information is provided here.

Element Description

Add a description comment behind all parameters and variables.