Was ist Code-Doku­men­ta­tion?

Doku­mentation von Quell­text ist vielen Programmierern ein Dorn im Auge. Aber Doku­mentation ist ein­fach un­ver­zicht­bar, um auch noch Monate später den Code ver­stehen zu können. Daher muss die Code-Doku­men­ta­tion so ge­wählt werden, dass sie ihren größten Nutzen bringt, d.h. keine Romane, sondern kurze, sinnvolle In­forma­tionen. Da die Doku­men­ta­tion direkt im Code durch­ge­führt wird, ist sie i.d.R. aktuell. Auf dieser Basis können dann Doku­men­ta­tionen dynamisch z.B. in HTML ge­neriert werden.