Wo kommentieren? Header oder Quelltext?

[DonDozone]

Hallo zusammen,

ich habe mal eine Frage bezüglich des guten Programmierstils. Ich bin gerade dabei für ein relativ Umfangreiches C++ Projekt von mir den Quellcode zu kommentieren (mit Doxygen btw). Jetzt stellt sich mir die Frage, wo die Kommentare zu den Funktionen am besten aufgehoben sind, in den Headern oder in den Quelltextdateien. Ich würde jetzt mal sagen in den Headern, aber vielleicht gibt es da ja einen guten "Kommentierstil", wo was hingehört?

Vielen Dank im Vorraus,
DonDozone

 

[Skini]

Überall:

#include <iostream>
//deklarieren von funktion und variablen
int funktion(a, b, c);
int  a, b, c;
int main()
{
//eingabe von werten
cout >> "eingabe a b c:";
cin << a << b << c;
//aufruf von funktion
funktion(a, b, c)
retuurn 0;
}
int funktion()
{
//ausgabe
cout >> a >> b >> c;
}

 

[kle-ben]

Deine Doxygen Kommentare werden nur in den Header Files ausgewertet.
Und dort sollte man auch kommentieren, da dort die Schnittstelle spezifiziert ist.
Im Code stehen lediglich die Kommentare die den Programmfluss beschreibt.

In den Headern stehen also die Beschreibungen der Parameter und der Rückgabewerte der Methoden.

Benny