记录WPF项目时的最佳实践

时间:2011-03-16 16:35:19

标签: c# wpf documentation

我目前正在记录包含各种用户控件的应用程序。现在我想知道记录时的最佳实践。您是否在用户控件中记录了这两个类?或者只有背后的代码?

2 个答案:

答案 0 :(得分:3)

我倾向于仅在有意义的地方记录XAML,比如描述某些样式集的作用或标记块的工作方式。我倾向于保留代码中的大多数注释,因为它们通常更容易阅读和遵循。另外,我倾向于使用后面的代码来尝试理解代码的作用,而不是跳到阅读XAML。

答案 1 :(得分:3)

首先,最佳做法是遵循WPF项目中的MVVM模式。我遵循它,你根本不会有代码隐藏。因此,只有一个地方需要记录。

但我明白并非总是如此。所以我的一般建议是:保持文档尽可能接近其记录的逻辑。并把它放在将要阅读它的人希望它看到的地方。如果它是最有可能在intellisense中查看的类的一般描述,那么将它放在代码隐藏类中。如果是用户界面的描述,则放入XAML文件。