Kommentare in Designer-Datei

Alles rund um die Programmierung mit Qt
Antworten
frogi001
Beiträge: 3
Registriert: 20. März 2009 00:15
Wohnort: Landshut

Kommentare in Designer-Datei

Beitrag von frogi001 »

Hallo zusammen,

weiss jemand, wie ich in die vom Designer generierte *.ui - Datei
Kommentare einfüge, die ich später bei der Erstellung der
Dokumentation nutzen kann ?
Oder ich füge die Kommentare in die vom uic erzeugten Headerdateien
ein. Diese werden aber auch wieder gelöscht, wenn ich mit dem
Designer etwas am Widget verändere !!

mfG

HS

P.S. benutzte Qt-Version: 4.3.4 (Betriebssystem: Linux)
upsala
Beiträge: 3946
Registriert: 5. Februar 2006 20:52
Wohnort: Landshut
Kontaktdaten:

Beitrag von upsala »

Ein .ui-File ist doch normalerweise selbsterklärend.
Aber die erzeugte Header-Datei wird doch von dir wieder in eigene Datei eingebunden. Dort kann man dann wieder kommentieren.
frogi001
Beiträge: 3
Registriert: 20. März 2009 00:15
Wohnort: Landshut

Beitrag von frogi001 »

Hallo,

das mit dem "selbsterklärend" finde ich auch ! :D
... mein Prof. aber nicht ! :?
Wenn ich mit dem Designer ein Widget erstelle, sagen wir mal es
enthält einem einzigen Button (ich nenne ihn "UltraWichtig"), dann
kann ich später natürlich darauf zugreifen (eingebundene Header-Datei).
Nun erzeuge ich (mit irgendeinem Tool) meine Dokumentation zu
den Dateien, und dort ist dann unter Member aufgeführt:
QPushButton UltraWichtig;
... sonst nichts.
Ich hätte noch gerne einen Kommentar (normalerweise vor der
Deklaration des Buttons) eingefügt, warum dieser nun so "ultrawichtig"
ist, der dann später vom Dokumentationstool ausgelesen, und in die
Doku geschrieben wird.

mfG

HS
kater
Beiträge: 306
Registriert: 29. Dezember 2009 01:13
Wohnort: Darmstadt

Beitrag von kater »

Du meinst für Programme wie Doxigen die eine Doku aus den Kommentaren in den Sourcen erstellt. Glaube nicht, dass das geht.
Ansonsten fällt mir dazu nur die Klasse QWhatsThis ein.
upsala
Beiträge: 3946
Registriert: 5. Februar 2006 20:52
Wohnort: Landshut
Kontaktdaten:

Beitrag von upsala »

Die Header-Datei wird vom uic automatisiert erstellt, ohne daß man dort Kommentare einfügen kann. Sollte man dies doch wollen, muß man entweder damit leben, daß diese Kommentare bei jeder Änderung überschrieben werden, oder den Designer und den uic erweitern.
frogi001
Beiträge: 3
Registriert: 20. März 2009 00:15
Wohnort: Landshut

Beitrag von frogi001 »

Hallo,

so wie es aussieht geht es wohl wirklich nicht ... na ja, hilft eben nicht :?
Habe aber nun eine "Ausweichlösung" gefunden (fuer doxygen):
Eine einfache Textdatei anlegen -> die noetigen Kommentare einfach
hintereinander reinschreiben (mit dem Kommando \var + voll qualifizierter
Variablenname) -> Textdatei beim Durchlauf von doxygen angeben, und
das wars. Die Kommentare erscheinen in der Doku so, als waeren
sie direkt in die Quelldatei geschrieben worden ...

mfG

HS
Antworten