Forum: PC Hard- und Software Träumerei? "Literate Programming Editor"


von Nick M. (Gast)


Lesenswert?

Hi!

Zur Zeit mach ich massiv Doxygen. Ist prinzipiell in Ordnung. Nur ist 
die Sprache etwas ... hmm ... naja, geht schon. :-)

Gestern Abend ist mir beim Einschlafen die Idee gekommen, dass Doxygen 
eigentlich einen Teil der Forderung von D. Knuth in seinem Buch 
"Literate Programming" erfüllt. Zumindest wäre es ein Baustain dafür.
Aber dazu müsste es einen Code-editor geben, mit dem man den Code 
editieren kann und die Doxygen Ausgabe. Und das ganze gleich zusammen 
rendert und darstellt. WISIWIG komplett halt. Fragt mich nicht wie das 
zu bedienen sein soll, das ist jetzt auch sekundär.

Gibt es so einen Editor?
Oder ist die Idee so unnütz, dass es so einen Editor nie geben wird?

von Strubi (Gast)


Lesenswert?

Die Idee ist gut, ich wuerde sowas auch nutzen.
Es gibt dafuer das 'language server protocol', auf der Basis kannst du 
entsprechende Plugins hinzimmern. Ueber den Overhead von JSON-RPC kann 
man sich streiten, aber damit waere das 'live'-Rendering einfach per 
Browser abzuhaken.
Wenn das effektiv ein unabhaengiger Server-Daemon waere, den man leicht 
per FCGI oder was auch immer aufrufen kann, wuerde ich das haben wollen.
Ich vermute aber schwer, dass es sowas fuer zahlende Projektleiter auch 
schon gibt (um live die Dokumentationswilligkeit der arbeitenden 
Code-Monkeys zu monitoren).

von Nick M. (Gast)


Lesenswert?

Strubi schrieb:
> Es gibt dafuer das 'language server protocol', auf der Basis kannst du
> entsprechende Plugins hinzimmern.

Ich kann es nicht. Das ist absolut nicht mein Metier.

von MaWin (Gast)


Lesenswert?

Nick M. schrieb:
> Gibt es so einen Editor?

Ja und nein.

prinzipell geht das mit jedem (WYSIWYG)Editor, der einem Textabschnitt 
ein bestimmtes Attribut geben kann.

Den kann man dann nämlich als 'code' kennzeichnen und der Compiler nutzt 
einen Procompilerlauf in dem er diesen Text aus dem Dokument extrahiert.

Leider verliert man damit bei den mir bekannten Editoren (Word, ...) die 
Features eines modernen Source-Code Editos: Syntaxhighlight, 
Fehlermarkierung, Bezeichner und Klammermarkerung, Springen zur 
Definitionsstell etc.

Man ist also wieder auf recht rudimentäre Quelltexteditore 'Notepad' 
beschränkt.

Doxygen halte ich für untauglich.

Ein WYSIWYG Wordprocessor, der durch "Skripte" erweitert werden kann, 
die Textabschnitte ähnlich DOM in Formatierung (ggf. versteckte 
Attribute) und Zustand des Einklappen/Ausklappen ändern können, könnte 
man wenigstens so erweitern daß er Sourcecode in seinem Text ordentlich 
behandeln kann, kenne ich aber auch nicht.

von Nick M. (Gast)


Lesenswert?

MaWin schrieb:
> Den kann man dann nämlich als 'code' kennzeichnen und der Compiler nutzt
> einen Procompilerlauf in dem er diesen Text aus dem Dokument extrahiert.

Naja, so solls nicht sein.
So wie der Syntax highlighter ständig durch den Source wuselt und die 
Farbattribute ändert, sollte er den Doxygen-text (für Dich: DOM) 
komplett rendern und formatiert darstellen. Das HTML-like gerausche im 
source stört mich. Und ich würde gerne im gerenderten Doxy-text direkt 
editieren können, ohne dessen Syntax zu kennen (ja, das wird wohl 
schwierig).

Ja, die Doku sollte man auf/zuklappen können oder nur die Doku in einem 
zweiten Fenster öffnen können. Bzw. durch ctrl-click auf eine Funktion 
die Doku gerendert darstellen.

Ja, die Doxygen Kommentare /** ... */ kann ich in meinem Editor einfach 
zuklappen. Dazu muss ich nur auf jeden klicken. :-/

Ist nur so eine Idee von mir die mir aber gefällt. Ich erwarte nicht, 
dass sich jetzt jemand hinsetzt und das "schnell mal" programmiert. :-)

Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.