Wie dokumentiert man einfache Methoden in der UML?

Question

Als Teil einer Neuschreibung einer alten Java-Anwendung in C# schreibe ich eine Software-Design-Spezifikation. Ein Problem, auf das ich stoße, ist, wenn eine Methode zu einfach ist, um sich mit einem Sequenzdiagramm zu beschäftigen (sie interagiert nicht mit anderen Objekten).

Als Beispiel habe ich ein einfaches POJO namens Item, das die folgende Methode enthält:

public String getCategoryKey() {
    StringBuffer value = new StringBuffer("s-");
    value.append(this.getModelID());
    value.append("-c");
    return value;
}

Der Zweck und der Algorithmus der Methode müssen dokumentiert werden. Ein Sequenzdiagramm ist jedoch überflüssig. Wie würden andere es dokumentieren?

(Ich übernehme keine Verantwortung für die angegebene Methode, es ist sehr alter Code und der Autor hat "vergessen", seinen Namen in die Javadoc zu schreiben).

Answer 1

Das Problem, das Sie haben, ist, dass Sequenzdiagramme für die Beschreibung von Nachrichtensequenzen verwendet werden, aber wie Sie sagen, ist die Sequenz nicht interessant genug, um mit einem Sequenzdiagramm dargestellt zu werden.

Eine weitere Möglichkeit sind Interaktionsdiagramme, die keine Abläufe, sondern interagierende Objekte beschreiben, allerdings kann dies

Y

W

H