Code-Dokumentation

Dieser Namensbereich dient der Verwaltung der DSAo-Md (Code-)Dokumentation. Neuen Programmierern soll dadurch der Einstieg erleichtert werden, außerdem dient es natürlich als Nachschlagewerk, auch wenn es nicht primär als Referenz aufgebaut ist (dafür ist der Code gut genug dokumentiert).

Als Einstieg bietet sich der Überblick und die Statusseite an.

Wir erstellen regelmäßig eine API-Dokumentation mittels Doxygen, jene jederzeit eingesehen werden kann.

Hier die grobe inhaltliche Struktur des Namensbereichs:

• Richtlinien - Verschiedenen Richtlinien.
  • Formatierungskonventionen - Empfehlungen für die Formatierung von Dokumenten
  • Inline-Dokumentation - Standards für die Inline-Dokumentation, die jeder Programmierer zu leisten hat
  • Programmierstandards - Hier werden die Erwartungen an neue Programmierer beschrieben
  • Sprachkonventionen - Standards für die Dokumente dieses Wikis.
  • Vorkenntnisse - Benötigte Kenntnisse für Programmierer und Designer.
• Installation - Hier wird die Installation von DSAo-Md unter Windows und Linux beschrieben.
• Versionsverwaltung - Eine kleine Einführung in die von uns verwendete Versionsverwaltung.
• Grundstruktur - Hier soll die Grundstruktur von DSAo-Md mit hilfe eines Klassendiagramms vermittelt werden.

Alle anderen Dokumente im Namensbereich Code (also diesem hier) sollen kurze, relativ formlose Dokumentationen zu einzelnen Mechanismen, Techniken, Ideen etc. die bei DSAo-Md zum Einsatz kommen, darstellen, damit andere Programmierer sich einen Überblick über Algorithmen und Abläufe verschaffen können, ohne den gesamten Code intensiv durcharbeiten zu müssen.

Alle Dokumente sind über die linke Leiste aufrufbar, hier eine Liste der Dokumente, die auf den aktuellen Stand gebracht werden müssen oder noch unvollständig sind: