Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

[Michael2203]

Hallo zusammen,

Seit Jahren nutze ich Documentation Insight zur Dokumentation des Quelltextes (XMLDOC - Format).
Seit 3 Jahren wird das nicht mehr weiter entwickelt und angepasst.

Einen bösen BUG hat es auch, wenn man den Bezeichner Namen ändert und gleichzeitig in der Erfassung der Dokumentation steht,
dann hilft nur noch ein Neustart der IDE.

Jetzt habe ich mich hingesetzt und einen GExperts Experten geschrieben, der die Erfassung auch kann.
Generierung nicht, dafür gibt es andere Tools.

Mir ist die Integration in CodeInsight wichtig, damit ich die Kommentare überall im Projekt lesen kann.

Den Experten habe ich öffentlich gestellt und er kann hier herunter geladen und in GExperts integriert werden: https://github.com/i-matic/CodeInsightEdit_Public

Eine kleine Anleitung habe ich beigefügt.

Viel Spaß beim Dokumentieren.

[Uwe Raabe]

Zitat:

Zitat von Michael2203 (Beitrag 1538862)

Seit Jahren nutze ich Documentation Insight zur Dokumentation des Quelltextes.
Seit 3 Jahren wird das nicht mehr weiter entwickelt und angepasst.

Meine letzte Version ist von März 2022 und aktuell läuft immerhin eine Beta, die auch Delphi 12 unterstützt.

Zitat:

Zitat von Michael2203 (Beitrag 1538862)

Mir ist die Integration in CodeInsight wichtig, damit ich die Kommentare überall im Projekt lesen kann.

In den Code-Templates, die Delphi mitliefert, findet man auch einige zum Erstellen dieser XMLDoc Tags.

[Michael2203]

Hallo Uwe,

das mit der Beta ist ja interessant. Habe immer Rechnung erhalten und bezahlt, aber keine Infos über Beta zu Delphi 12 erhalten.
Auf der Homepage ist die letzte Version V3.11.12.10 von Dezember 2021 für Delphi 11.

Ja das mit den Templates weiß ich. Aber durch die parallele Eingabe bin ich verwöhnt ...

Wenn ich direkt die Dokumentation schreibe, geht das leichter von der Hand.

Es war ja auch nur ein Angebot, meine GExperts nutzen zu können.

Vielleicht hilft es ja jemandem.

[Uwe Raabe]

Zitat:

Zitat von Michael2203 (Beitrag 1538864)

Es war ja auch nur ein Angebot, meine GExperts nutzen zu können.

Vielleicht hilft es ja jemandem.

Das wollte ich auch gar nicht in Abrede stellen - lediglich ein paar Ergänzungen zum Thema machen.

Wegen der Beta könntest du Baoquan ja einfach mal anschreiben. Ich weiß halt nicht, nach welchen Kriterien die Teilnehmer ausgesucht werden.

[Der schöne Günther]

Die Bilder in deiner Readme auf Github fehlen, kannst du die noch nachziehen?

[Michael2203]

Danke für den Hinweis, Bilder wurden aktualisiert.