Suche eine Gute Dokumentationsvorlage für ein C/C++ Programm
-
Wie der Titel schon sagt suche ich eine Dokumentationsvorlage für ein C/C++ Programm. Wäre echt nett wenn mir jemand eine an marc.helbling@gmx.ch senden würde. Schon mal THX an alle die mir weiterhelfen können.
-
Was meinst du mit "Dokumentationsvorlage"? Eine Vorlage wie man C/C++ Programme dokumentiert?
-
Ich weiß nicht, vielleicht kann dir Doxygen helfen?
-
naja wenn man ein programm macht dann macht man eine dementsprechende Dokumentation dazu.
Titelblatt
Inhaltsverzeichniss
Code beschreibenung (funktionen definitionen warum gewählt und so)
Struktogramm
Probleme des Programms
Installationshinweis
Kontakteinfach so zeugs
-
Das reicht aber imo nicht aus. Ein gut dokumentierter Code ist meistens aussagekräftiger und effektiver.