I have been working with WPF/Silverlight since March 2008 and have learnt a lot of things. I wrote a lot of articles on Silverlight and published them on my blog. Today, I decided to share some of the best practices you should follow while developing in WPF/Silverlight. Hope this will help you guys while writing XAML code. Read and try to be strict with the guidelines whenever you are modifying your XAML.
Feedback is always appreciated. Hence, don’t forget to leave your comments at the end. If you have any more points, please share them. I will review them and add those here.
Some of the XAML coding best practices are mentioned below:
- Don’t use unnecessary “xmlns” namespaces in the XAML file. This overburdens the load time of the Silverlight page (If you are using Resharper, you can do this very easily as it will change the color of the unnecessary items to Grey).
- Don’t add the same namespaces multiple times in a single XAML page. It screws up the XAML code at the time of maintenance and also loads the assembly namespace multiple times causing various memory issues at runtime.
- Use proper name for your “xmlns” namespace prefix. For example:
xmlns:commonControls is more meaningful than
xmlns:cctrl. This avoids multiple declarations of namespaces.
- Try avoiding “xmlns” namespace prefix name as “
local”. Instead use “
localControls” or “
- When adding a control that has no elements inside it, better to close it by self-closing tag “
/>” instead of the hard closing tag (
- Remove all unnecessary resource keys if they are not in use. These increases the memory uses and you may sometimes encounter some animation issues due to this. If you need it at a later point of time, you are always welcome to add it.
- Don’t use extra panels (e.g.
Canvas, etc.) unless they are required.
- Always try to use
Grid as your panel first and if you require other panels, use them.
- Never try to give a name to all of your controls inside your Silverlight page as it takes unnecessary object creation at the time of load. Name only those elements which you want to use from your code behind and/or from your XAML. If you are using MVVM pattern, you can remove the naming of your controls in almost all the cases.
- Use the
Visibility property of the controls instead of the
Opacity property to hide the content.
- Use proper formatting of your XAML code. This gives better look of code and is also easy to maintain in the future.
- Use comments in XAML whenever required.
- Try to use
StaticResource instead of
DynamicResource as it increases the performance and also it throws exceptions at development time. Hence, it is easier to identify the root cause.
- Remove unnecessary styles if they are not required at all.
- Try to add your styles in a separate file if you want to share them across your application. If they are specific to a single page, then add them in the page resource.
Kunal Chowdhury is a former Microsoft "Windows Platform Development" MVP (Most Valuable Professional, 2010 - 2018), a Codeproject Mentor, Speaker in various Microsoft events, Author, passionate Blogger and a Senior Technical Lead by profession.
He is currently working in an MNC located in India. He has a very good skill over XAML, C#, Silverlight, Windows Phone, WPF and Windows app development. He posts his findings, articles, tutorials in his technical blog (www.kunal-chowdhury.com) and CodeProject.
Connect with Kunal on: