2 votes

Comment documenter des méthodes simples en UML ?

Dans le cadre de la réécriture d'une ancienne application Java en C#, je suis en train de rédiger une spécification de conception logicielle. Un problème que je rencontre est lorsqu'une méthode est trop simple pour s'embêter avec un diagramme de séquence (elle n'interagit pas avec d'autres objets).

A titre d'exemple, j'ai un POJO simple appelé Item, contenant la méthode suivante :

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

L'objectif et l'algorithme de la méthode doivent être documentés. Cependant, un diagramme de séquence est excessif. Comment les autres le documenteraient-ils ?

(Je ne prends aucun crédit/blâme pour la méthode donnée, c'est un très vieux code et l'auteur a "oublié" de mettre son nom dans la Javadoc).

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X