Discussion :

[oodini]

Bonjour,

J'avais déclaré dans une classe parente une méthode abstraite, puis je l'ai définie dans chacune des classes enfant par override.

J'avais fait la documentation dans la classe parente. Or, quand je demande à créer la documentation XML, Visual me dit que la méthode dans les classes enfant n'est pas documentée. Dois-je redocumenter chacune des classes enfants ?

[Er3van]

Bonjour,

J'avais déclaré dans une classe parente une méthode abstraite, puis je l'ai définie dans chacune des classes enfant par override.

J'avais fait la documentation dans la classe parente. Or, quand je demande à créer la documentation XML, Visual me dit que la méthode dans les classes enfant n'est pas documentée. Dois-je redocumenter chacune des classes enfants ?

Si tu les overrides dans tes classes enfants ça me parait assez logique...

[oodini]

Je mets override parce qu'il me semble qu'il n'y a pas d'autre moyen de dire qu'on est en train d'implémenter une fonction définie plus haut dans la hiérarchie.

Mais la documentation doit être commune pour chacune des implémentations.

La conception orientée objet du C# permet de factoriser le code, mais pas la documentation ?

[Er3van]

Tu rajoutes une couche en plus quand tu fais un override, et même potentiellement tu redéfinis complètement, donc ta documentation doit évoluer en fonction.

Si tu factorises le code, tu n'as pas à faire un override, tu as juste à appeler ta classe mère, qui ne doit pas être abstracte du coup.

[oodini]

Je rajoute une couche, mais la documentation que je donne peut être tout à fait générique.

Par exemple, si ma méthode s'appelle readFile(), et qu'elle est implémentée par diverses classes travaillant chacune sur un type de fichier différent, je n'ai pas besoin de documenter en détail chacune des implémentations.
J'ai juste besoin de mettre le commentaire Read file pour la méthode de la classe mère (et encore, parce que Visual exige que je documente, mais le nom de la fonction se suffit à lui-même). Le reste, c'est du détail d'implémentation, que je peux choisir de ne pas documenter. D'ailleurs, j'ai trouvé la balise qui va bien, mais qui n'est pas proposée par IntelliSense :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

/// <inheritdoc />