Freeware "Pascal Input Helper" für XMLDoc in Delphi verfügbar

[Harry Stahl]

Ich habe ja in meinen Pascal Project Manager & Editor eine Möglichkeit zur Dokumentation von Delphi-Projekten eingebaut.

Das funktioniert inzwischen recht gut mit umfangreichen Möglichkeiten, aber ich denke man will das ja auch i.d.R. direkt in Delphi selber machen, wenn man gerade an dem Projekt arbeitet (wobei natürlich auch nachträgliche Dokumentation mit dem Pascal Editor immer Sinn macht und sehr komfortabel geht).

Daher habe ich einen Teil der Funktionalität in ein kleines Extra-Tool gelegt, das in JEDER Delphi-Version verwendet werden kann, da es nicht über die Tools-API integriert ist, sondern benötigte Informationen einfach über die Zwischenablage erlangt werden und so auch die Texte in Delphi eingefügt werden.

Das Programm ist nur ca. 0,7 MB groß und ist hinsichtlich CPU, Speicherverbrauch etc. ein "nichts".
Es kann natürlich nicht so viel wie andere kostenpflichtige Tools, die sich über die Tools-Api in Delphi einklinken, aber es erleichtert im Vergleich zur manuellen Eingabe der XML-Tags die Arbeit doch allgemein. Und man kann es auch in allen Delphis nutzen, was bei den kommerziellen Lösungen i.d.R. nicht der Fall ist.

Es ist Freeware, also macht damit was Ihr wollt, aber natürlich auf eigenes Risiko.

Anliegend ein Screenshot und nachfolgend Links zu einem kurzen Video und Download:

Video: https://t.co/TXmJJnrjhf?amp=1

Download: https://www.devpage.de/fmxdownloads.htm

Ein paar Änderungen, die ich noch im Pascal Editor hinsichtlich XMLDOC Erfassung vorhabe, werden dann später in Updates der Freeware einfließen. Das Programm hat keine Werbung, keinen vorgeschalteten Info-Dialog oder sonstiges, es ist einfach nur ein hoffentlich auch für Euch hilfreiches "Tool".

Vielleicht noch ein kurzer Hinweis: Das mit dem Hotkey ist erforderlich, weil das Programm bei Aufruf des Hotkeys ermittelt, welches gerade das aktive Programm und das aktive Fenster ist, so dass dann beim späteren Einfügen des Textes direkt das richtige Programm und Fenster wieder aktiviert werden kann.

[Uwe Raabe]

Zitat:

Zitat von Harry Stahl (Beitrag 1465911)

aber es erleichtert im Vergleich zur manuellen Eingabe der XML-Tags die Arbeit doch allgemein.

Eigentlich sollte auch mit Bordmitteln keiner die XML-Tags von Hand eingeben müssen. Schließlich werden passende Code-Templates (z.B. summary, returns, para, ...} bereits mitgeliefert. So lässt sich ein Summary Tag ganz einfach mit <Ctrl-J>su<Enter> oder summary<Ctrl-J> erstellen.

[Harry Stahl]

Zitat:

Zitat von Uwe Raabe (Beitrag 1465916)

Zitat:

Zitat von Harry Stahl (Beitrag 1465911)

aber es erleichtert im Vergleich zur manuellen Eingabe der XML-Tags die Arbeit doch allgemein.

Eigentlich sollte auch mit Bordmitteln keiner die XML-Tags von Hand eingeben müssen. Schließlich werden passende Code-Templates (z.B. summary, returns, para, ...} bereits mitgeliefert. So lässt sich ein Summary Tag ganz einfach mit <Ctrl-J>su<Enter> oder summary<Ctrl-J> erstellen.

Das ist mir schon klar, dass die (neueren) Delphis das unterstützen. Aber Du musst dann jedes mal Ctrl+J für den Tag, den Du verwenden willst, aufrufen. Außerdem wird es umständlich, wenn Du einzelne Parameter dokumentieren willst oder Du da später einen ergänzen willst.

Außerdem verhält sich Strg + J auch manchmal seltsam. Z.B. wenn der Cursor auf "Procedure" steht und ich Ctrl+J aufrufe, wird das in "procedure MyProcedure () begin end" umgewandelt und ähnliches. Muss also manuell erst mal eine Leerzeile einfügen, damit das überhaupt funktioniert.

Manche Tags werden von Delphi gar nicht unterstützt, etwa "example" oder "exeption". Davon abgesehen, wird da ja noch einiges hinzukommen (habe ich angedeutet), etwa vereinfachtes Einfügen von HTML-Links (img src und href). Ich verwende das Tool schon seit Jahren mit der Textbaustein-Funktion. Damit füge ich meine Regions, IFDEFS und alles mögliche ein. Das steht mir jederzeit für jede Delphi-Version zur Verfügung, ohne dass ich bei einer neuen Delphi-Version etwas kompliziert übernehmen müsste, etc.

Aber auch hier gilt: Wer es nützlich findet, der kann es verwenden, wer es überflüssig findet, lässt es halt...

[himitsu]

Zitat:

Zitat von Uwe Raabe (Beitrag 1465916)

Schließlich werden passende Code-Templates (z.B. summary, returns, para, ...} bereits mitgeliefert. So lässt sich ein Summary Tag ganz einfach mit <Ctrl-J>su<Enter> oder summary<Ctrl-J> erstellen.

Irgendwie findet im 10.4 das CodeInsight diese Templates nicht mehr (existieren tuen sie aber noch), bzw. zu oft geht bei Strg+Leertaste das garnicht erst auf.

Nja, auch wenn die verfügbaren Möglichkeiten von Delphi schon bissl "unpraktisch" sind und es ist echt schade, dass der Anbieter die kleine Version des DocumentationInsight nicht mehr im Delphi standardmäßig ausliefern lassen wollte.

[Harry Stahl]

Zitat:

Zitat von himitsu (Beitrag 1465956)

Nja, auch wenn die verfügbaren Möglichkeiten von Delphi schon bissl "unpraktisch" sind und es ist echt schade, dass der Anbieter die kleine Version des DocumentationInsight nicht mehr im Delphi standardmäßig ausliefern lassen wollte.

Witziger weise habe ich das DocumentationInsight erst beim letzten Delphi-Frühstück kennen gelernt, als Frank (alias Mavarik) das erwähnte. Seit Delphi XE6 ist es nicht mehr dabei. Hatte aber in der Basis-Funktion viele Restriktionen. Hab mir mal die Vollversion angesehen, aber dann entschieden eine eigene Dokumentation in meinen Pascal Editor einzubauen, da ich noch viele andere Dinge in der Dokumentation haben will, die bei DocInsight nicht vorgesehen / machbar sind...

EDIT (31.05.2020, 16: 30 Uhr): Für den Pascal Input Helper gabs gerade auch einen Fix, wenn die Zwischenablage keinen Text enthielt, funktionierte mit Aufruf des Hotkeys die Anzeige der Form nicht...

[Andreas13]

Hallo Harry,
ich hätte zwei kleine Verbesserungsvorschläge für Deinen Pascal Input Helper :thumb: :

1):
In der untersten Zeile steht der Speicherort für Textbausteine.txt. Diese Zeile sollte zwecks Datensicherung kopierbar sein.

2):
Im rechten Memo-Fenster verwendest Du eine nichtproportionale Schriftart mit fester Breite. Das ist OK.
Wenn man aber in den Edit-Modus schaltet, wird eine Proportionalschrift verwendet. Damit lassen sich die Spalten untereinander nur schwer bündig ausrichten. Besser wäre durchgängig eine Schriftart mit fester Breite, schließlich soll der Textblock primär in den Delphi-Editor kopiert werden.

Danke und viele Grüße
Andreas

[Harry Stahl]

Zitat:

Zitat von Andreas13 (Beitrag 1501748)

Hallo Harry,
ich hätte zwei kleine Verbesserungsvorschläge für Deinen Pascal Input Helper :thumb: :

1):
In der untersten Zeile steht der Speicherort für Textbausteine.txt. Diese Zeile sollte zwecks Datensicherung kopierbar sein.

2):
Im rechten Memo-Fenster verwendest Du eine nichtproportionale Schriftart mit fester Breite. Das ist OK.
Wenn man aber in den Edit-Modus schaltet, wird eine Proportionalschrift verwendet. Damit lassen sich die Spalten untereinander nur schwer bündig ausrichten. Besser wäre durchgängig eine Schriftart mit fester Breite, schließlich soll der Textblock primär in den Delphi-Editor kopiert werden.

Danke und viele Grüße
Andreas

OK, habe beides entsprechend übernommen. Die aktualisierte Version kannst Du vom bekannten Ort (https://www.devpage.de/fmxdownloads.htm) herunter laden.

War irgendwie seltsam mal wieder mit Delphi 5 zu arbeiten... Aber ein Programm, das nur 600 kb groß wird, hat ja auch was...

[Andreas13]

Herzlichen Dank, Harry! :thumb: :angel:
Viele Grüße, Andreas

[juergen]

Hallo Harry,

danke für das Tool! Bin da grad am testen ob mir das Tool helfen kann. :-)
Ich bin mir nicht sicher ob ich vllt. etwas falsch mache, aber ich schreibe manchmal Funktionen verteilt auf mehrere Zeilen (pro Parameter eine Zeile).
Etwa so:

Delphi-Quellcode:

    FUNCTION change_YYYYMMDD_in_DateTime(
      s: STRING;
      idx: Integer { im Fehlerfall den fehlerhaften i-Wert der Schleife protokollieren }
      ): TDateTime;
...

Wenn eine Funktion auf mehrere Zeilen verteilt ist scheint dein Programm das nicht zu berücksichtigen, oder?
Jedenfalls sind bei mir die Parameter leer.

[Harry Stahl]

Hallo Juergen,

schau doch mal, ob Du mit der aktualisierten Version 1.04 zurecht kommst...