How to review dotnet code

Question

i am looking for guidance or best practice to review my code or review my colleague code working in same company.

two way i guess exist to review code. one is manual process and one should be automated process where people may use various tools to review code.

so please discuss two different process called manually review code and automated way review code using tools.

please guide me in details. thanks

Nilesh Shah · Answer

Both ways should be implemented for code review first with automated tools because it takes away the tedious task of going thru lot of code by human eyes. I always use Visual Studio code analysis tool for this. This is simple most and integrated inside VS so it's handy. In many organizations I worked for it is rule that everywhere has to run this tool on thier code before checkin and they have to solve all the code analysis warnings before checkin code. This practice will help eliminate most obvious coding mal practices. Then a code review manually by peers or supirior is needed which targets some perfrmance improvements code reuse etc But here also every organization has thier set of code standards which needs to be followed

Afzaal Ahmad Zeeshan · Answer

Yes these are the two methods to review the code but not the practices. The practices involve how a code is reviewed. The practices differ from organization to organization and from team to team. Reviews such as how much inheritance should be there how much polymorphism to be applied etc. So now let me give you an overview of what I believe about the two methods you talk about Manual process The manual process is slow process and would not follow the rules 100%. The person can reject a code based on personal preferences and accept the bad code based on the same preferences. Thus manual process needs to ensure that the person reviewing the code has no personal preference or hatred toward a coding practice. Otherwise the results are not good. On the other hand the manual process is simpler and less expensive because you do not need to purchase a subscription for an automation service. Automated process For an automated process you purchase a cloud or on-premises solution that follows the patterns finds the problems with the code -- the problem can be anything and so can be the test such as unit testing integration testing etc. You apply all of these steps and then the review of a code is performed. The testing can also include and involve the code standard code size or even the code runtime performance to be tested here. Many cloud solutions such as Visual Studio Team Services solutions can be used to test the code automatically. You can use these services however they are expensive for many teams and require a subscription or license to use the services. Rest assured the overall task to accomplish is same: Review the code . The methods and means used here are different and the time they consume to perform each task is also different... Automated will perform faster and generate the results quickly.

Tapan Patel · Answer

what you are asking is a of vast disucssion please narrow down the topic so that people can help you. If you have speicific code that needs review you can post it here. What I would suggest to get started is to 1. If you want to go with Automated route (which is kind of okay) find some tools like telerik just code Resharper RedGate ANTS (all paid) that helps you track your execution and lets you know the performance of your code. 2. If you want to go manual route you may want to understand the platform on which you are working on. Also how the compiler interprets the programming language (and Algorithms based on the problem/requirement) so that you can write the good code. All modern compilers do the good job of handling bad code but still. But most of all it needs practice and practice..... A lot.

Afzaal Ahmad Zeeshan · Answer

Please have a look here https://www.visualstudio.com/en-us/docs/tfvc/get-code-reviewed-vs The reviews that a machine can do are based on the performance metric resource usage memory leakage etc. The reviews for the naming conventions etc is all done manually because machines don't know what the underlying meaning for that variable is.

tri_inn · Answer

@Tapan can you provide some good url which help me to learn C# based code review technique. my company maintain no convention or guide line for coding but i want to learn good coding practice and when some one review my code then he/she will not get any flaw rather find good qaulity of code. so tell me how could i prepare my code and review my code. thanks

tri_inn · Answer

@Nilesh thanks for your answer. How Visual Studio code analysis help to review code. can you give me any link which help me to use it to review my code before release. i am from small organization where no rule is there for coding but i am want to learn code review area to sharpen my area of coding. another question is what are the area is checked or consider when we review the code ? code performance memory consumption or coding guide line or convention ? please give me some idea. suppose when you will review ones code then what are the area you will check in code ? please discuss.

tri_inn · Answer

@afzaal thanks for your answer. How Visual Studio Team Services is used to review code automatically. can you give me any good article link which help me to implement. another question is what are the area is checked or consider when we review the code ? code performance memory consumption or coding guide line or convention ? please give me some idea. suppose when you will review ones code then what are the area you will check in code ? please discuss afzaal