11 Dec
2004
11 Dec
'04
5:42 p.m.
On Sat, Dec 11, 2004 at 05:13:30PM +0100, Erik Schanze wrote:
Hi!
Hi Erik,
Wie sollte man solche Kommentare am besten einbauen?
Ich persönlich bevorzuge Doxygen für C++.
Wie detailliert sollten sie sein?
Es sollte eine generelle Beschreibung der Klasse geben, dann eine Beschreibung für jede öffentliche Methode in der der Funktionsumfang und die Eigenheiten erwähnt werden.
Bei der API von Bibliotheken sollten immer Beispiele aufgeführt sein, wie man die API am besten verwendet.
- In welche Dateien gehören diese Kommentare? *.cxx oder *.hh?
IMHO in den Header, da man so auch ohne den Quelltext nachlesen kann was die Klassen/Methoden anbieten.
Ciao, Tobias
--
Separate politics from religion and economy!