Seite 1 von 1

Automatisch Funktionen dokumentieren (Creator)

Verfasst: 2. November 2009 12:17
von AuE
Hi,

gibt es im Creator die Möglichkeit eine Funktion (cpp/h) automatisch mit nen template dokumentation zu versehen? Evtl ext. Tools?

Im VS gabs es da so eine Fkt das man einfach die Funktion makiert => Tastenkombi ergebnis:

Code: Alles auswählen

/*
FUNKTION: bla
Input: int a
Input: int b
Output :int
Deskription: TODO
*/
int bla( int a, int b)
{...}

Verfasst: 2. November 2009 12:23
von lepsai

Code: Alles auswählen

/**
my doxygen comment to this function
*/
void f();
Ich würde also Doxygen empfehlen. Wird übrigens auch von den trolls verwendet...

Verfasst: 2. November 2009 12:28
von AuE
IHi,

thx für die AW....das will ich ja später auch. Ich suche quasi nach einen template was mir diese grobe Struktur automatisch in meinen Code reinbringt!

Verfasst: 20. November 2009 13:32
von Kenni
das würde mich auch interessieren, ob das mit doxygen oder einem anderen tool möglich ist. :D

Verfasst: 20. November 2009 14:09
von RavenIV
Kenni hat geschrieben:das würde mich auch interessieren, ob das mit doxygen oder einem anderen tool möglich ist. :D
Doxygen läuft ja im Nachhinein über die Quelldateien und erstellt aus den Kommentaren im Doxygen-Format eine html-Doku. Doxygen erstellt keine Kommentare, sondern wertet sie aus.

Die Funktion, einen Kommentarblock einzufügen, muss die Entwicklungsumgebung (QtCreator, Eclipse, MS DevStudio, usw) bereitstellen. Manche IDEs können das per Tastendruck (drücke <Strg><Umschalt><Taste> und es wird ein Standard-Kommentarblock eingefügt) oder per Textersetzung (schreibe "class<Leerzeichen>" und es wird "Kommentarblock class Name { }" hingeschrieben)

Verfasst: 23. November 2009 10:14
von Mani99
RavenIV hat geschrieben:
Kenni hat geschrieben:das würde mich auch interessieren, ob das mit doxygen oder einem anderen tool möglich ist. :D
Doxygen läuft ja im Nachhinein über die Quelldateien und erstellt aus den Kommentaren im Doxygen-Format eine html-Doku. Doxygen erstellt keine Kommentare, sondern wertet sie aus.

Die Funktion, einen Kommentarblock einzufügen, muss die Entwicklungsumgebung (QtCreator, Eclipse, MS DevStudio, usw) bereitstellen. Manche IDEs können das per Tastendruck (drücke <Strg><Umschalt><Taste> und es wird ein Standard-Kommentarblock eingefügt) oder per Textersetzung (schreibe "class<Leerzeichen>" und es wird "Kommentarblock class Name { }" hingeschrieben)
Diese feststellung haben wir jetzt zum dritten mal in diesem thread.

Da ich auch an einer lösung interessiert bin, kurz noch eine info:

Wir hätten gerne gewusst, ob der qt creator automatisch kommentarblöcke erstellen kann.

Wir wollen nichts über doxygen und sonstiges wissen!

Verfasst: 23. November 2009 10:22
von RavenIV
Mani99 hat geschrieben: Wir hätten gerne gewusst, ob der qt creator automatisch kommentarblöcke erstellen kann.

Wir wollen nichts über doxygen und sonstiges wissen!
Warum belästigtst Du uns dann hier?
Geh doch auf die Homepage des QtCreator und schau Dich dort mal um.
Falls Du nichts findest, schreib dem Hersteller eine email.
Wenn das auch nicht klappt, dann nimm Deinen Kuschelteddy und weine eine Runde.

:evil: :evil: :evil:

Verfasst: 23. November 2009 10:34
von Mani99
RavenIV hat geschrieben:Warum belästigtst Du uns dann hier?
Tut mir leid wenn ich dich in einem forum mit einer frage belästige... :roll:
Geh doch auf die Homepage des QtCreator und schau Dich dort mal um.
Sind nicht sonderlich viele brauchbare informationen auf der homepage dazu vorhanden!
Wenn das auch nicht klappt, dann nimm Deinen Kuschelteddy und weine eine Runde.
Hab keinen kuschelteddy, zählt was anderes auch?

Verfasst: 23. November 2009 10:38
von RavenIV
Mani99 hat geschrieben:
Geh doch auf die Homepage des QtCreator und schau Dich dort mal um.
Sind nicht sonderlich viele brauchbare informationen auf der homepage dazu vorhanden!
Daraus würde ich schliessen, dass es das im QtCreator nicht gibt.

QtCreator ist noch relativ jung und daher nicht gerade mit Funktionen oder Bedienerfreundlichkeit überschüttet.
Einfach noch etwas warten oder einen Feature-Request dafür erstellen.

Verfasst: 23. November 2009 11:37
von -=Freaky=-
RavenIV hat geschrieben:
Mani99 hat geschrieben:
Geh doch auf die Homepage des QtCreator und schau Dich dort mal um.
Sind nicht sonderlich viele brauchbare informationen auf der homepage dazu vorhanden!
Daraus würde ich schliessen, dass es das im QtCreator nicht gibt.

QtCreator ist noch relativ jung und daher nicht gerade mit Funktionen oder Bedienerfreundlichkeit überschüttet.
Einfach noch etwas warten oder einen Feature-Request dafür erstellen.
oder ggf. ein eigenes plugin schreiben ;)
ich waere auch interessiert ...

mfg,
julian