C++ Programmierung / Doku / Referat

[neffets]

Hi Leute,...
wir haben in der Schule im ersten Halbjahr ein C++ Programm geschrieben.(Ampelsteuerung mit Bedienpult und 3 Ampeln)
Jetzt sollen wir über unsere Arbeit ein Referat/Dokumentation schreiben. Nur Quelltext hinschreiben und kommentiern find ich da etwas öde... hat jemand schonmal sowas gemacht und kann mir vielleicht ein Beispiel zukommen lassen wie sowas aufgebaut ist? Da wir ja ein eigenes Projekt haben klaue ich euch auch nichts... ihr könnt auch gerne Teile weglassen... Würde mich freuen...

[Masotoshi]

Ja, das kenne ich. Mussten wir im ersten Halbjahr auch eine Zeit lang machen.

In unsere Doku mußte folgendes enthalten sein:

• Kurze Beschreibung des Programms (Was ist der Sinn des Programms ? /Wofür wurde es geschrieben?)
• Kompletter Quellcode inkl. Kommentaren zu den einzelnen Funktionen
• Struktrogramm

Und das war es dann auch schon.
Leider hab ich so eine Doku nur noch in gedruckter Form vorliegen (muß ich sowieso mal suchen ), da unsere Daten aus dem ersten Halbjahr gelöscht wurden.

[Lars]

Würde ich auch so machen. Ein Quellcode lässt sich nunmal am besten anhand seiner selbst erläutern. Alles andere ist nur noch verwirrender.

[Strogij]

Nur Quelltext oder inkl. Schnittstelle zur Ampelanlage mit LEDs mit z.B. USB? In welcher Klasse bist du?

[neffets]

Das Programm läuft nur grafisch auf dem Bildschirm...
Über ein Steuerpult kann man "grafische" Ampeln ansteuern und diese per Hand oder Automatik schalten. Ist nicht grad so viel aber es ist auch unser erstes großes objektorientiertes Projekt.
Klasse TGI 2 (Ja so ist die eigentliche Bezeichnung) d.h. Technisches Gymnasium mit Profil Informationstechnik in der 12. Klasse
In einem andren Fach programmieren wir einen Microcontroller, auf dem laufen dann ein par LEDs