Best practice when documenting WPF projects [closed]

Question

I'm currently documenting my application that consists of various User Controls. Now I'm wondering how the best practice is when documenting. Do you document both classes in a user control? Or only the code behind?

Answer 1

First of all, the best practice is to follow MVVM pattern in WPF projects. I you follow it, you will not have the code-behind at all. So there will be only one place to document.

But I understand that it is not always the case. So my general advice is: keep the documentation as close to the logic that it documents as possible. And put it where the person who is going to read it expects it to see. If it is a general description of a class that most likely will be viewed in the intellisense, then put it on the code-behind class. if it is a description of a user interface, then put in the XAML file.