Bei der Dokumentation eines Systems solltest Du Dir, wie sakura bereits beschrieb, Gedanken über die Zielgruppe machen. Ausgehend von diesem Ansatz sind die Schlagworter
innere Sicht und
äußere Sicht verbreitet und legen dabei die Schwerpunkte auf den unterschiedlichen Umgang (Wartung vs. Verwendung) mit dem System fest.
Paradoxerweise sind die von der Delphi-
IDE automatisch generierten Attribute entgegen dem Ansatz des
Geheimnisprinzips immer öffentlich, so dass sich der Gedanke stellt, ob man den gängigen Ansatz, "alles was Public/Published ist, gehört zur
äußeren Sicht", in diesem Fall verfolgen sollte...
Sofern Du nicht den für viele Delphi-Entwickler typischen Weg gehst, "von außen" Aufrufe der Form
Delphi-Quellcode:
AForm.Edit1.Text:= 'A Text';
AForm.Label1.Caption:= Format('Length of Text is ',
[Length(AForm.Edit1.Text)]);
umsetzen zu wollen, sondern stattdessen entsprechende Aufrufe der Form
AForm.AProperty:= 'A Text';
realisierst, würde ich die generierten Attribute zur
inneren Sicht zählen und somit bei Klassendiagrammen zur äußeren Sicht, zB zur Schnittstellendokumentation, verbergen.
Zitat
Baum-Darstellung
