OVH Cloud OVH Cloud

Documentation de ses design patterns

1 réponse
Avatar
Pierre THIERRY
Je suis en train de chercher, pour l'instant avec des résultats mitigés,
comment documenter le plus proprement et conventionnellement possible
les desgins patterns dont je me sers.

Vous, comment faites-vous ?

Curieusement,
Nowhere man
--
nowhere.man@levallois.eu.org
OpenPGP 0xD9D50D8A

1 réponse

Avatar
kanze
Pierre THIERRY wrote:
Je suis en train de chercher, pour l'instant avec des
résultats mitigés, comment documenter le plus proprement et
conventionnellement possible les desgins patterns dont je me
sers.

Vous, comment faites-vous ?


En tête de classe, après la rôle et les responsibilités, j'ai
une section : patterns. Avec Doxygen, j'ai défini une commande
patterns pour le faire.

Dans certains cas, je dirais que le modèle se documente tout
seul. Si je vois une classe avec une fonction statique qui
s'appelle instance (ou getInstance), qui renvoie un pointeur ou
une référence à la classe, et qu'en plus, tous les constructeurs
sont privés, je suppose d'office le modèle singleton.

--
James Kanze GABI Software
Conseils en informatique orientée objet/
Beratung in objektorientierter Datenverarbeitung
9 place Sémard, 78210 St.-Cyr-l'École, France, +33 (0)1 30 23 00 34