AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Sprachen und Entwicklungsumgebungen Sonstige Werkzeuge Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts
Thema durchsuchen
Ansicht
Themen-Optionen

Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

Ein Thema von Michael2203 · begonnen am 14. Jul 2024 · letzter Beitrag vom 15. Jul 2024
Antwort Antwort
Benutzerbild von Michael2203
Michael2203

Registriert seit: 14. Jul 2024
Ort: Essen
3 Beiträge
 
Delphi 12 Athens
 
#1

Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

  Alt 14. Jul 2024, 22:36
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.
Miniaturansicht angehängter Grafiken
codeinsightedit.png  
Michael

Geändert von Michael2203 (14. Jul 2024 um 23:17 Uhr)
  Mit Zitat antworten Zitat
Benutzerbild von Uwe Raabe
Uwe Raabe

Registriert seit: 20. Jan 2006
Ort: Lübbecke
11.475 Beiträge
 
Delphi 12 Athens
 
#2

AW: Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

  Alt 14. Jul 2024, 23:18
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.

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.
Uwe Raabe
Certified Delphi Master Developer
Embarcadero MVP
Blog: The Art of Delphi Programming
  Mit Zitat antworten Zitat
Benutzerbild von Michael2203
Michael2203

Registriert seit: 14. Jul 2024
Ort: Essen
3 Beiträge
 
Delphi 12 Athens
 
#3

AW: Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

  Alt 15. Jul 2024, 07:19
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.
Michael
  Mit Zitat antworten Zitat
Benutzerbild von Uwe Raabe
Uwe Raabe

Registriert seit: 20. Jan 2006
Ort: Lübbecke
11.475 Beiträge
 
Delphi 12 Athens
 
#4

AW: Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

  Alt 15. Jul 2024, 09:35
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.
Uwe Raabe
Certified Delphi Master Developer
Embarcadero MVP
Blog: The Art of Delphi Programming
  Mit Zitat antworten Zitat
Der schöne Günther

Registriert seit: 6. Mär 2013
6.176 Beiträge
 
Delphi 10 Seattle Enterprise
 
#5

AW: Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

  Alt 15. Jul 2024, 10:28
Die Bilder in deiner Readme auf Github fehlen, kannst du die noch nachziehen?
  Mit Zitat antworten Zitat
Benutzerbild von Michael2203
Michael2203

Registriert seit: 14. Jul 2024
Ort: Essen
3 Beiträge
 
Delphi 12 Athens
 
#6

AW: Kommentare schreiben wie Documentation Insight in Delphi 12 mit GExperts

  Alt 15. Jul 2024, 11:35
Danke für den Hinweis, Bilder wurden aktualisiert.
Michael
  Mit Zitat antworten Zitat
Antwort Antwort

 

Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 02:30 Uhr.
Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz