[Suche] Wiki für Source-Code / Source-Code Dokumentation

[arbu man]

Ich dokumentiere im Quelltext mittels DocComment, das hat den Vorteil ich bin näher am Quellcode um muss nicht für jede Änderung der Dokumentation in eine Wiki/bzw. anderes System. Auch zeigt meine IDE diese Kommentare in der Codecompletion an.

Zusätzlich erstelle ich kommentierte Tests die zeigen wie die Komponenten meiner Software genutzt werden. Mit Kommentieren Tests meine ich das auch Zeilen oder Code Abschnitte Kommentare haben, wenn dies Hilfreich ist. Ein weiterer Vorteil ich bekomme mit wenn ein Test nicht mehr läuft, somit ist meine "Dokumentation" bzw. HowTo immer auf den neusten Stand und ich setze die Dokumentation nicht der Gefahr aus, das der in der Doku beschriebene Weg nicht funktioniert.

Zu guter Letzt verwende ich einen durchdachten und konsistenten Programmierstil der auch Analysen zulässt, beispielsweise kann ich mir eine .graphml-Datei generieren lassen die die Klassen Struktur meines Projektes aufzeigt. Diese Graphen tragen auch zu Dokumentation bei, sie beantworten Fragen wie:
Welche Klassen sind besonders wichtig/werden oft benutzt ?
In welchen Klassen wird meine Klasse xy verwendet ?
usw.

Prinzipell sehe ich bei Systemen die nicht in der IDE integriert sind immer die Gefahr das diese Schlect/Nicht benutzt werden.

Um nochmal auf deine Frage zurückzukommen im Grunde macht der phpDocComment genau das was du willst, er ist nur kein eigenes System, was ich besser finde. Es gibt aber Software die aus dem phpDocComment eine Webseite generiert.

Gruß Björn