Quellcode Einbindung

  • Hallo!

    Ich würde gerne in einem hübschen, leserlichen Format Java Quellcode in meine Arbeit einbinden.
    Als sinnvollstes Tool zur Quellcodeeinbindung ist mir lstlistings untergekommen (irgendein anderes Tool hab ich auch ausprobiert, dass pdfs erstellt glaub ich...hat mir aber nicht gefallen), aber bei allzuviel Code (die Klasse hat nunmal viele Methoden) sieht der Quellcode auch damit einfach nicht mehr ansehnlich aus. Es sind einfach wahnsinnig viele Seiten, und ich bin mir sicher: das schaut sich niemand jemals an.

    Ich würde deshalb gerne wissen, wie ihr das mit eurer DA handhabt. Gehört dort überhaupt soviel Quellcode hinein? Wenn ja: wie formatiert ihr das meistens (bunt?)? Ist es euch egal, dass sich der Code über Seiten ausbreitet, die nie ein Mensch hintnach nochmal ansehen wird? Gebt ihr nur (wichtige) Teile des Codes hinein, den ihr dann beschreibt?
    Klar, dass v.a. mein Betreuer damit zufrieden sein muss, ich weiß nur gerade selbst nicht, was ich von so einem Codegeschwall halten soll und wie ich damit am besten umgehen kann :(

    Ihr glücklichen Augen, Was je ihr gesehen, Es sei wie es wolle, Es war doch so schön!

  • Der gesamte Quellcode des Implementierungsteils (z.B. bei meiner DA mehrere 10 000 Zeilen Code) gehoert mMn nicht in die wissenschaftliche Arbeit. Die "Knackpunkte" der (eigens entwickelten und) verwendeten Algorithmen sollten beschrieben und abgebildet werden. Das API - sofern es eines gibt - kann ruhig in einem Anhang aufgenommen werden, insb. wenn die DA als Basis fuer zukuenftige Arbeiten dienen soll/kann.
    Weiters: es gibt viele Diplomarbeiten/Disseratationen online; bzw. sollten sich alle von deinem "Heimats"institut/Arbeitsbereich in der Institutsbibliothek befinden: ein paar anschauen bzw. vll zu deinem Thema passende Arbeiten lesen (auch fuer Zitate/Referenzen) hilft sicher, um zu einer guten Struktur zu finden.
    Aber wie du schon schreibst: der Betreuer ist genau fuer solche Fragen da!

    Ahja, ich nehm bei lstlisting gern eine kleinere Schriftart - z.B. \begin{lstlisting}[basicstyle=\ttfamily\footnotesize] ...

  • Der gesamte Quellcode des Implementierungsteils (z.B. bei meiner DA mehrere 10 000 Zeilen Code) gehoert mMn nicht in die wissenschaftliche Arbeit. Die "Knackpunkte" der (eigens entwickelten und) verwendeten Algorithmen sollten beschrieben und abgebildet werden. Das API - sofern es eines gibt - kann ruhig in einem Anhang aufgenommen werden, insb. wenn die DA als Basis fuer zukuenftige Arbeiten dienen soll/kann.

    Nur Teile in die Arbeit zu nehmen ist auch das, wo ich mich gefühlsmäßig am ehesten hingezogen fühle. Danke für die Bestätigung :)
    Es ist nur irgendwie so frustrierend, wenn das Programm DAS ist, was die meiste, eigene Arbeit ausmacht (die Textzusammenfassungen im "Background" Teil oder das "Related works" Kapitel, die einfach standard sind, kann ich kaum als meine Leistung sehen...) und dann kann mans nicht einmal mit abgeben. Und es fällt mir auch noch irre schwer viel darüber zu schreiben, außer was das Programm circa macht und was rauskommt (niemand sollte seitenlang über originelle if-while-Konstrukte schwafeln, nicht?). Hinzu kommt, dass ich das Bedürfnis habe, soviel Information wie möglich mitzugeben, ich hab ja schließlich auch lange gebraucht um sie mir zu erarbeiten ... aber lesen wird das ja eh niemand :(
    Nein, du hast schon recht - weniger ist besser.


    Weiters: es gibt viele Diplomarbeiten/Disseratationen online; bzw. sollten sich alle von deinem "Heimats"institut/Arbeitsbereich in der Institutsbibliothek befinden: ein paar anschauen bzw. vll zu deinem Thema passende Arbeiten lesen (auch fuer Zitate/Referenzen) hilft sicher, um zu einer guten Struktur zu finden.
    Aber wie du schon schreibst: der Betreuer ist genau fuer solche Fragen da!


    Ich glaube, ich habe erst letzte Woche hier irgendwo jemand den Tipp gegeben, sich alte LVAs anzusehen um zu wissen, was darin so gemacht wird - aber für mich selbst komm ich auf solche Ideen nicht, Danke!

    Ahja, ich nehm bei lstlisting gern eine kleinere Schriftart - z.B. \begin{lstlisting}[basicstyle=\ttfamily\footnotesize] ...


    Das hab ich eh auch schon gemacht, hab sogar ganz nette Versionen gefunden mit farblichen Syntax-Highlighting (das sich aber wohl nur bei einer nicht-druck Variante auszahlt...extra Geld für hübschen Code werd ich wohl nicht aufbringen...)

    Ihr glücklichen Augen, Was je ihr gesehen, Es sei wie es wolle, Es war doch so schön!

  • Zusatzinformation, falls jemand so unbedarft ist wie ich:

    Die TU Bibliothek bietet sogar in der einfachen Suche unter "Feld" das Attribut "Diss/DiplArb (Betreuung)" an, sodass man wirklich einfach nach Arbeiten suchen kann, die vom eigenen Betreuer betreut wurden. Und da es online auch noch jede Menge Volltexte gibt, hilft das ungemein dabei, sich Ideen von anderen zu borgen/klauen ;)

    Ihr glücklichen Augen, Was je ihr gesehen, Es sei wie es wolle, Es war doch so schön!

  • kurz wie es bei mir war: lstlistings und nur wichtige stellen und die entsprechend im text kommentiert. bei einer diplomarbeit ist es noch etwas anders, aber wenn du dir papers anschaust oder schreibst, hast du dort auch keine kompletten listings, sondern pseudo-code oder du verwendest sowas wie das "algorithmic" environment.

    du verkaufst die idee, nicht den code. bei diplomarbeiten wuerde ich es auch wieder nicht so streng sehen, aber der code ist meist nur das vehikel um zu zeigen, dass deine mechanismen wirklich funktionieren (zb. in einer experimental evaluation section).

    nebenbei mag ich bei solchen arbeiten gar nicht gerne code herzeigen. nicht weil man etwas verbergen will, aber gedrucktes papier laeszt sich nur sehr schwer patchen ;)

    Willfähriges Mitglied des Fefe-Zeitbinder-Botnets und der Open Source Tea Party.

Jetzt mitmachen!

Sie haben noch kein Benutzerkonto auf unserer Seite? Registrieren Sie sich kostenlos und nehmen Sie an unserer Community teil!