Tuesday, December 14, 2010

ASP.Net Best Coding Practices

As per my experience in the development / coding i found following as the best practices in ASP.Net application development.

These will definitely improve the application performace, maintanance and reliability.

1. Remove unused private fields and functions.

2. Do not cast unnecessarily. Avoid duplicate casts where possible, since there is a cost associated with them.

3. Properties that return arrays are prone to code inefficiencies. Consider using a collection or making this a method.

4. To test for empty strings, check if String.Length is equal to zero. Constructs such as "".Equals(someString) and String.Empty.Equals(someString) are less efficient than testing the string length. Replace these with checks for someString.Length == 0.

5. Methods in the same type that differ only by return type can be difficult for developers and tools to properly recognize. When extending a type, be sure not to define new methods that differ from base type methods only by type.

6. Use stringbuilder instead of string types for string manipulation.

7. Use String.Format instead of concatenating and appending strings.

8. Use Type.TryParse rather than Convert.ToDestinationType(). For example use int.TryParse() rather than Convert.ToInt32() which might throw an exception.

9. Override Equals() method wherever applicable in your classes.

10. Consider passing base types as parameters - Using base types as parameters to methods improves re-use of these methods if you only use methods & properties from the parameter's base class. E.g. use Stream instead of FileStream as a parameter when only calling Stream.Read(), this makes the method work on all kind of streams instead of just File streams.

11. Do not catch general exception types - You should not catch Exception or SystemException. Catching generic exception types can hide run-time problems from the library user, and can complicate debugging. You should catch only those exceptions that you can handle gracefully.
12. Use properties instead of visible instance fields.

13. Follow the same naming conventions accross the solution.

14. Remove unwanted commented code, Indent code properly.

15. Use curly braces with in an if statement, even if there is a single statement in the if block. This will provide better readability.

16. Make sure to refactor your code to move the duplicated code to common reusable functions.

17. Move one time control settings into the .aspx page rather than having them in the code behind in if(!IsPostback) block.

18. Use inheritance whereever possible, which enables code reuse and also reduces the amount of code we have to write and test.

19. Move the reusable javascript functions to an external .js file instead of having them on the page.

20. For controls that are declarativley specified on the page, tie the event handlers to the controls events on the aspx page rather than initializing them in the codebehind. If the controls are built dynamically then we donot have a choice.

21. Make sure to check for nulls when using any type retrieved from a session, querystring or a database to avoid NullReferenceExceptions.

22. Use foreach loop instead of using for loop which may lead to out of boundary run time exceptions.

No comments: