Bild als Kommentar

[Thom]

Vielen Dank Jens01 für den Link!
Diese Technik funktioniert übrigens auch ganz hervorragend mit Bildern! :thumb:

Anhang 36833

[sx2008]

Gut möglich, dass man in 10 Jahren Text-, Bild-, Audio- und Videodateien per Drag & Drop in den Sourcecode ziehen kann und die IDE automatisch eine Verknüpfung herstellt.
Sozusagen: Sourcecode Linking and Embedding

Beim Embedding zeigt die IDE das Bild oder Video an Ort und Stelle (die Datei liegt natürlich ausserhalb des Sourcecode) und beim Linking öffnet sich ein neues Tab mit dem Inhalt.

PS: in diesem Forum lesen doch auch Mitarbeiter vom Embacadero mit.
Einfach 2 neue Compilerdirectiven (eigentlich sind es IDE-Directiven) aufnehmen, mit der man Multimediadateien in den Sourcecode einbetten oder verküpfen kann.

[Furtbichler]

Im Kontext des 'literate programming' (z.B. D.E.Knuth: Tangle & Weave) wäre das eine Möglichkeit, die dann jedoch über einen Link realisiert würde.
Auch die Aussage

Zitat:

Zitat von Luckie (Beitrag 1163938)

wenn du schon ein ganzes Bild brauchst, dann machst du was falsch.

kann man so stehen lassen.

Ich glaube, man wirft hier 'dokumentieren', 'kommentieren' und 'erklären' in einen Topf. Das sollte man nicht.

Zu einem Softwaresystem, das selbstverständlich selbstkommentierend ist (also ohne Kommentare auskommt), gehört natürlich eine Systemdokumentation, das die Verfahren, Quellen und Hintergründe beschreibt. Inklusive Bildchen.

[FXL]

Ersteinmal vielen Dank für die vielen Kommentare!

Eigentlich hatte ich eingestellt, dass ich bei Antworten eine Email Benachrichtung bekomme - leider hat das nicht funktioniert - darum meine verspätete Antwort.


Warum ich Bilder im Quellcode haben möchte? Ich habe viele mathematische Funktionen, in dem ein kleines Bildchen schnell und einfach veranschaulicht, was genau in der Funktion gemacht wird und was als Output raus kommt.

Da ich in dieser Unit nicht alleine programmiere, kann so ein Bild viel vereinfachen.

Aber einige haben schon recht - das Ziel muss es natürlich sein, den Quellcode für sich sprechen zu lassen und Bilder direkt als Quellcodekommentar würde das Betrachten mit einem einfchen Texteditor erschweren.

Darum werd ich wohl doch eher eine externe Dokumentation bevorzugen und mit einem Link im Quellcode verknüpfen!


Vielen Dank nochmal - ein cooles Forum bzw. gute Leute hier!!!