Hallo,
ich habe für eine Studienarbeit ein relativ umfangreiches Programm geschrieben. Bewertet wird aber anhand Ausarbeitung, d.h., der Professor/Betreuer schaut sich sicherlich/wahrscheinlich nicht den Code an. Geschrieben habe ich die Arbeit mit LaTeX. Nun frage ich mich, wie ich den Code am besten in die Arbeit basteln kann. Ich habe zwar einigermaßen konsequent Javadoc-Kommentate eingebaut, will aber jetzt keine HTML-Seiten hinter die Arbeit klemmen. Wichtige Abläufe werde ich mit UML-Diagrammen darstellen, manche Funktionen will ich aber auch mit Code dokumentieren.
Kennt jemand hier eine gute Methode, wichtige Codefragmente in einer Ausarbeitung zu dokumentieren? Vielleicht direkt im Quelltext (also Kommentieren im Quelltext, dann extrahieren und nach LaTeX konvertieren), damit ich die Arbeit der Dokumentation nicht doppelt machen muss? Ich bin gerade über "doxygen" gestolpert, werde mir das jetzt mal ansehen. Wenn jemand andere Werkzeuge kennt, wäre ich sehr dankbar für Tipps.
Grüße
Philipp
ich habe für eine Studienarbeit ein relativ umfangreiches Programm geschrieben. Bewertet wird aber anhand Ausarbeitung, d.h., der Professor/Betreuer schaut sich sicherlich/wahrscheinlich nicht den Code an. Geschrieben habe ich die Arbeit mit LaTeX. Nun frage ich mich, wie ich den Code am besten in die Arbeit basteln kann. Ich habe zwar einigermaßen konsequent Javadoc-Kommentate eingebaut, will aber jetzt keine HTML-Seiten hinter die Arbeit klemmen. Wichtige Abläufe werde ich mit UML-Diagrammen darstellen, manche Funktionen will ich aber auch mit Code dokumentieren.
Kennt jemand hier eine gute Methode, wichtige Codefragmente in einer Ausarbeitung zu dokumentieren? Vielleicht direkt im Quelltext (also Kommentieren im Quelltext, dann extrahieren und nach LaTeX konvertieren), damit ich die Arbeit der Dokumentation nicht doppelt machen muss? Ich bin gerade über "doxygen" gestolpert, werde mir das jetzt mal ansehen. Wenn jemand andere Werkzeuge kennt, wäre ich sehr dankbar für Tipps.
Grüße
Philipp
Zuletzt bearbeitet: