Hallo Katrin,
bei meinem 1-2-3 Hinweis habe ich mehr an die Dokumentation durch Kommentare im Code gedacht. Die Vor- und Nachbedingungen stammen aus der algebraischen Definition. Beschrieben werden Ausgangs- und Endzustände der Objektvariablen über Prädikate.
Die Parameter sollten kaum Beschreibung nötig haben. Eine gute Namenskonvention und die konsequente Verwendung auch optionaler Schlüsselworte für die Aufrufkonvention (var, in, out, named, ... ) - zur Not auskommentiert, falls die Programmiersprache es nicht unterstützt - sollten ausreichen. Hilfreich ist darüberhinaus ein konsistentes Fachvokabular mit prosaischer Einführung aller Begriffe und Glossar.
Wenn du darüberhinaus noch diagrammgestützte Beschreibungen einzelner Methoden anfertigen möchtest, dann bist du bei
UML schon richtig. Es dürfte kaum einen Aspekt geben, den du nicht mit
UML beschreiben kannst. Alle Diagramme der behavioural model view kommen für deine Zwecke in Betracht: state-charts, sequence diagramms, collaboration diagrams und activity diagrams. Dein einziges Problem sollte die Wahl des Werkzeuges sein.
Freundliche Grüße
marabu