Bild als Kommentar

[FXL]

Hi,

ich benutzt Delphi XE und wollte fragen ob es irgendein Plugin gibt, dass ein Bild in den Quellcode als Kommentar einbindet?


Gruß

[Popov]

Machbar wäre es, aber Bilder verbrauchen viel Platz. Dazu käme das Problem, dass man es in Hex oder Base64 speichern müsste, was es noch größer machen würde. Man müsste viel scrollen.

[Luckie]

Äh, nein. Er will es schon als Bild im Quellcode haben. Wahrscheinlich um irgendewtas zu verdeutlichen. Aber wenn du schon ein ganzes Bild brauchst, dann machst du was falsch. Quellcode sollte selbsterklärend sein.

[BMI]

mal es doch als Flußdiagramm mit ASCII-Zeichen

das hab ich schon häufiger gesehn.

Code:

//     (  Anfang  )
//     (    I     )
//     (  Mitte   ) IF ... Then ... Else
//     (   / \   )
//     (  /   \  )
//     ( I      I )
//     (Ende  weiter)

aber mach es nicht zu aufwendig, weil unübersichtlich


aber Bilder z.B. von nackten Mädels können auch schlecht(en) dokumentierten Quellcode nicht aufwerten



EDIT: äh, oder meinst Du zufällig ein ICON als Bild einbinden? 32x32
das müßte gehen ...
(wenn das allerdings als Resource auch besser aufgehoben wäre ,glaub ich ... )
dazu kann Dir bestimmt jemand was sagen

[lbccaleb]

Wenn es nicht unbedingt direkt im Quellcode sein muss, dann könntest du deinem Programm(Source) eine HtmL-Datei beipacken und in dieser den Source mit deinen Bildern zeigen. Ich glaube hier in der DP oder irgendwo im Netz gab es sogar nen fertiges Programm Delphi Source in HtmL Dateien umzuwandeln, dann müsstest du nur noch deine Bilder hinzufügen.

Auf die schnelle gefunden: http://www.pazera-software.com/products/pas-to-htm/

[Daniel]

Zitat von Luckie:

Aber wenn du schon ein ganzes Bild brauchst, dann machst du was falsch. Quellcode sollte selbsterklärend sein.

Da gehen Theorie und Praxis aber mächtig weit auseinander, oder? Ob ein Bild mitten im Quellcode gut aufgehoben wäre - sei mal dahingestellt. Aber zur Veranschaulichung von Zusammenhängen kann ein Bild ein wertvoller Teil der Dokumentation sein.

Ich finde solche pauschalen Verurteilungen immer etwas "schwierig".

[Thom]

Zitat von Luckie:

Aber wenn du schon ein ganzes Bild brauchst, dann machst du was falsch. Quellcode sollte selbsterklärend sein.

Wenn ich einen fremden Quelltext nicht verstehe, dann liegt das also nicht an mir, sondern am Programmierer der vorliegenden Quelle. Ja, na klar. Weg mit Dokumentationen und Hilfetexten inklusive Illustrationen. Sowas braucht der Profi nicht.
Und wenn ich ein Mathe- oder Physikbuch nicht verstehe, liegt das selbstverständlich auch an den unfähigen Autoren und keinesfalls am mir. Diese Einstellung lob' ich mir. Die paßt genau in die heutige Zeit: An allem sind prinzipiell die anderen Schuld...

Zur eigentlichen Frage: Bilder haben im Quelltext tatsächlich nichts zu suchen, denn dieser soll eigentlich mit jedem beliebigen Texteditor zu öffnen und zu bearbeiten sein. Um Bilder einbetten zu können, sind komplexere Dateiformate notwendig, wie zum Beispiel RTF, XML oder die der großen Office-Programme. Damit kommt aber natürlich kein Compiler zurecht. Deshalb sind Bilder - und die erklären bekanntlich mehr als 1000 Worte - besser in einer Dokumentation aufgehoben.
Ich bringe zum Beipiel auch gerne Links als Kommentar im Quelltext unter.

[himitsu]

Modelierungsunterstüzung/ModelSupport des Projekts aktivieren, dann zur ModelAnsicht der gewünschten Unit umschalten und dort kann man auch "richtige" Bilder reinmachen.


Wer will, der bekommt auch ein nacktes Mädel mitten in den Quellcode ... ASCII-Art macht's möglich.

Ansonsten sind Pixelgrafiken, in einem reinen Texteditor, etwas "schwer" realisierbar.


Naj, ich binn dann mal gespannt, was FMX noch sagt, bzw. wann/ob er noch erklärt, was er nun genau will.

[Jens01]

So einem Beitrag gab es auch mal. Es wird gleich ein ganzes Video quasi in den Quelltext eingebaut.

[himitsu]

Zitat von Jens01:

So einem Beitrag gab es auch mal. Es wird gleich ein ganzes Video quasi in den Quelltext eingebaut.

Funktioniert super

Halt, doch nicht so ganz.


Kann man Youtube denn vertrauen? Ich nutze den IE nie, also ist der auch nciht zu "lasch" eingerichtet.