Einen schönen Abend euch allen!
Im Moment überarbeite ich meine Library und möchte diese etwas besser dokumentieren.
Ich präsentiere folgenden Fall:
|
C-/C++-Quelltext
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
/// <summary>
/// Die Klasse ist stellt dies und das dar...
/// </summary>
class interface {
public:
/// <summary>
/// Beschreibe das Verhalten der Methode und etc.
/// </summary>
virtual void methode1() = 0;
// ...
};
|
Nun, die Klasse oben ist eine abstrakte Klasse und Nutzer meiner Library werden i.d.R. sich nur mit diesem Interface auseinandersetzen, wobei Instanzen von meiner Library erzeugt werden.
Gelegentlich wird es jedoch vorkommen, dass man mit der Implementierung direkt arbeiten muss.
Die Frage ist nun, wie würde ich die Implementierung korrekt dokumentieren, wenn man bedenkt, dass das Interface eigentlich schon das Verhalten komplett dokumentiert?
Gibt es da eine Art "Konvention" der ich folgen kann? Hat jemand zufällig ein Beispiel parat für eine "gute" Dokumentation einer Implementierung eines Interfaces?
MfG Julién