Beschreibung von Funktionen

Nospherates

Hi,
ich hab mal ne Frage bezüglich dem Kommentieren für Leute die den Quellcode nicht einsehen können.
Bei vielen Funktionen in C++ bekommt man ja sobald man sie auswählt eine Kurzbeschreibung was sie kann und natürlich die Übergabeparameter in einem gelben PopUp. Die Übergabeparameter und den Rückgabeparameter bekommt man ja auch bei den selbsterstellten Funktionen zu sehen, nur die Beschreibung nicht. Wie kann man sowas einbauen?

Gruß

spjoe

Das kommt auf die IDE an.
bei dvv-cpp wird auch das Kommentar über der Funktion im gelben PopUp angezeigt

bei vc .net könnte man mit gehe zu definition (meist nur vorwärts deklaration(source nicht frei) ein Kommenta drüber schreiben

mfg

Artchi

Also einmal muß das die IDE unterstützen, dazu schreibt man einen Kommentar über die Methode:

class test {

    // Dieser Kommantar erscheint beim User.
    void foo();
};

Ansonst kann ich auf jeden Fall www.doxygen.org empfehlen. Das erstellt aus einem ganzen C++-Projekt eine detailierte Klassen-Beschreibung incl. UML, wenn man will in einem HTML-Format.

Nospherates

Besten Dank <wenn mal alles so einfach wäre :D>

Gruß