You can use a list based on this link (yes, it's 2007, but its still valid) and copy this checklist in your code review doc: http://technet.microsoft.com/en-us/library/cc707802.aspx You might also be interested in checking out the dev section of the best practices overview page at http://social.technet.microsoft.com/wiki/contents/articles/8666.sharepoint-2010-best-practices-en-us.aspx#Development
Hi Santosh,
Did you create this exhaustive list of Code Review Checklist. Will you be able to share.
Thanks
I did create an exhaustive list but I'm not at liberty to share. To get you started, here are my viewpoints on a good code review checklist:
- Classify the risk associated to code.
- Review the installation guide
- Review the software architecture document
- Demand a description of the development process that was followed when developing the code, this includes stuff such as methodologies, architectural patterns and tools that were used
- Demand an explanation of how the code deals with extreme scenarios (such as working with large files, huge amounts of messages, etc)
- Review the test plan and results
- Review the performance plan
- Review the source code in an automated fashion via various tools (such as the ones in Visual Studio or spcaf) checking things such as static code analysis, code metrics and style.
- Check that assemblies are delivered in release mode
- Discuss the diagnostics capabilities in the code
- Discuss exception handling capabilities in code
- Create a list of items that increase the risk of code and measure those
- Run unit tests that are part of the delivery
- Use a tool like ILSpy to get some insights in the real quality of the code
Hi Santhosh,
Few of the important aspects of code reviews you could add it to you list :
1. Memory leak check ( disposal of objects )
2. Exception handling of the code blocks ( check for try/catch )
3. List pagination instead of looping through the list items ( Performance issue )
4. Write adequate logs with necessary information
5. Code has the required information header ( add comments on each code blocks )
Alternatively, you could use stylecop,fxcop, Resharper tools for code review. SharePoint Code Analysis Framework ( SPCAF) is more sharepoint focused and very userfriendly tool you could use.
Hope the above helps.
Regards,
Rajesh
http://sharepointr.blogspot.sg
- Proposed as answer by Ganesan Rajesh Kumar 12 hours 41 minutes ago