UNIT-HEADER-EXPERTE

[Ghostwalker]

Eine sehr leidige Angelegenheit für Entwickler (insbesondere im Open-Source-Bereich) sind die Unit-Headers. Das Editieren und Erstellen im Sourceeditor ist nicht wirklich komfortabel, und
früher oder später sind sie veraltet.

Nach langen Überlegungen und einigem tüffteln hab ich mich entschieden, den Vorschlag mit den Templates aufzugreifen.

Ich habe das Projekt in 3 Teile gegliedert:

Teil 1: Ein einfacher Template-Editor
Teil 2: Einstellungen
Teil 3: Der Experte an und für sich.

Der Editor für die Templates ist soweit gediegen, das ich ihn hier in einer ersten Version mal
Vorstellen kann. Eine Hilfedatei ist ebenfalls im Archiv vorhanden. Damit läßt sich schon mal
absehen wie so ein Template aussieht und welche Möglichkeiten sich damit bieten. Der Editor selbst wird
zusätzlich noch in den Experten mit integriert, so das schnell Änderungen an einem Template innerhalb der IDE möglich sind.

[Ghostwalker]

Was die Bedienung betrifft:

Es ist lediglich ein "Test und Entwicklungsframework". Will heißen, sobald alle Optionen/Daten drinn sind und das generieren/laden/speichern funktioniert, wird das alles in die IDE integriert


Template-Idee:

Jo, das ist sicher ne gute Idee. Allerdings ist damit keine Zeichengenau formatierung möglich, da
die Breite und Höhe des Headers ja wesentlich von den Daten abhängig ist, die erst eingebaut werden. Um
das in einem Template zu realisieren müssten dann zusätzlich auch noch Formatierungs-Befehle eingebaut
werden. Trotzdem werd ich die Idee mal im Hinterkopf behalten

[Edit vom zweitenmal durchlesen]

Zitat:

Zum Header selber, das Du da ein festes Format, das nur in Kleinigkeiten anpassbar ist, vorschreibst, würde das für mich ebenfalls sofort unbrauchbar machen.

Öhm...Hä ? Das einzige, das wirklich fix ist, sind die 1. und die letzte Zeile ('(*&','&*)'). Alles
andere kannst du einstellen wie du lustig bist. Das "nur" die Datenfelder (Datum, Autor usw.) vorhanden sind, ist klar. Ich kann nur etwas einbringen was ich kenne (wär bei der Templatevariante nicht anders).

[Ghostwalker]

Ich hab im Text des 1. Postings noch ein paar ergänzende Worte eingefügt, die hoffentlich den Sinn etwas näher erklären

Derzeitiger Stand:

Derzeit arbeite ich an der Integration in die IDE.

[CCRDude]

Sorry, ich seh das zweite Edit erst jetzt

Schau mal in meine pkWinINet.pas, als Beispiel für einen Header, wie ich den verwende. Der Autorenname etwa kommt zweimal vor! Einmal im JavaDoc-kompatiblen Header, einmal in meinem Hausinternen. Da kommt der Autor zweimal vor, und ich habe unterschiedliche Rahmen- und Trennzeichen. Alles etwa in den JavaDoc-Teil zu packen, ist nicht wirklich praktisch, da nicht alle Informationen auch in der Dokumentation erscheinen müssen/sollen. Lässt sich das Format der einleitenden und abschließenden JavaDoc-Zeile überhaupt mit Deinem Mechanismus generieren?

Hier ein Beispiel (allerdings nicht global, sondern nur für eine bestimmte Art von Unit, die ich automatisch erzeuge, halt), wie ich sowas selber mal in ein Template verpackt habe.

[Ghostwalker]

So in der Art noch nicht. Ehrlich gesagt hab ich so einen Header auch noch nie gesehen (also..doppelter Header quasi).

Die Sache mit den Dok-Headern ist aber eine interresante Erweiterung. Mal sehen was ich da tun kann.

[Ghostwalker]

Nach langem Hin und Her, zahlreichen Überlegungen, hab ich mich entschieden, den Vorschlag von CCRude aufzugreifen, und das ganze über Templates zu lösen.

Die ausschlaggebenden Argumente waren dabei die größere Flexibilität und die einfachere Internationalisierung der Header sowie die einfachere Erweiterbarkeit des Systems.

[Ghostwalker]

So, Teil 1 läuft soweit. (siehe 1. Posting).