Je suis en train de documenter mon application qui se compose de divers contrôles d'utilisateur. Je me demande maintenant quelle est la meilleure pratique en matière de documentation. Faut-il documenter les deux classes d'un contrôle d'utilisateur ? Ou seulement le code derrière ?
Réponses
Trop de publicités?
amurra
Points
8822
J'ai tendance à documenter le XAML uniquement lorsque cela a un sens, par exemple pour décrire ce que fait un certain ensemble de styles ou comment fonctionne un bloc de balises. J'ai tendance à garder la majorité des commentaires dans le code derrière car ils sont normalement plus faciles à lire et à suivre. De plus, j'ai tendance à consulter le code derrière pour essayer de comprendre ce que fait le code en premier lieu, au lieu de me lancer dans la lecture du XAML.
Tout d'abord, la meilleure pratique consiste à suivre le modèle MVVM dans les projets WPF. Si vous le suivez, vous n'aurez pas du tout de code-behind. Il n'y aura donc qu'un seul endroit à documenter.
Mais je comprends que ce n'est pas toujours le cas. Mon conseil général est donc le suivant : gardez la documentation aussi proche que possible de la logique qu'elle documente. Et mettez-la là où la personne qui va la lire s'attend à la voir. S'il s'agit d'une description générale d'une classe qui sera très probablement visualisée dans l'intellisense, alors mettez-la dans la classe code-behind. S'il s'agit de la description d'une interface utilisateur, alors mettez-la dans le fichier XAML.
