Nützliche Programm Doku unmöglich?
-
Gibt es keine Möglichkeit eine Doku für ein Programm so zu schreiben, dass man es schnell ändern oder erweitern kann? Ich hab noch nie eine gesehen. Entweder es gibt garnichts oder gleich wieder ganze "Bücher". Aber wer will den 200 Seiten lesen, nur weil er an nem Programm was ändern soll?
Ich mein jetzt nicht Dokus für Frameworks, sondern für selbst entwickelte Programme.
-
Die beste Dokumentation sind die Kommentare in einem Quellcode; sind diese gut, so braucht man als "erweiterte Dokumentation" höchstens einige Diagramme u. Erläuterungen, um den Überblick zu behalten.
-
Javadoc ftw
-
Was hab ich den von dokumentiertem Code, wenn ich ein fremdes Programm ändern soll? Soll ich dann erst mal die Hälfte des Codes lesen, bis ich die passende Stelle gefunden hab.
Nur weil ich Javadoc verwende muss die Doku noch lange nicht gut sein.
-
kommentator schrieb:
Was hab ich den von dokumentiertem Code, wenn ich ein fremdes Programm ändern soll? Soll ich dann erst mal die Hälfte des Codes lesen, bis ich die passende Stelle gefunden hab.
Mein Post nochmal lesen -> Nachdenken -> Aha-Effekt erleben.
kommentator schrieb:
Nur weil ich Javadoc verwende muss die Doku noch lange nicht gut sein.
Und ... ?
-
Reyx schrieb:
als "erweiterte Dokumentation" höchstens einige Diagramme u. Erläuterungen, um den Überblick zu behalten.
Das sagt garnichts aus. Wie sollen den die Diagramme aussehen, dass man alles genau findet? Wenn du ein Programm hast das aus mehreren 1000 Klassen besteht, dann hast du wieder so ein kleines Buch voller Diagramme und kommst doch nirgens hin.
-
Bei einem vernünftigen Entwurf stehen diese 1000 Klassen aber nicht wahllos in einem beliebigen Kontext. Für gewöhnlich kannst Du selbst große Anwendungen in Teilsysteme einteilen. Die Diagramme zeigen Dir dann entsprechend nur einen Ausschnitt. Divide and Conquer halt...
Natürlich musst Du über gewisse Informationen in den Diagrammen abstrahieren (sprich sie ausblenden), um sie möglichst kompakt zu halten und den Überblick zu behalten.