Shulou(Shulou.com)06/02 Report--

Today, I will talk to you about how to use StyleCop for code review, many people may not know much about it. In order to make you understand better, the editor has summarized the following content for you. I hope you can get something from this article.

Use StyleCop to review the original code to see if the code follows design specifications, .net conventions, some consistent usage, and so on. Ensure code consistency, readability, etc.

Before that, let's briefly introduce FxCop (originally a tool used internally by Microsoft), a tool that analyzes managed assemblies, checks the overall correctness of the code, and tells users where they don't meet the design specifications. The evaluation rules he uses have been developed for years, bringing together the knowledge and skills of top .net framework developers. But FxCop is based on managed code analysis, that is, compiled assemblies. The StyleCop we introduce today is also used to check whether the code conforms to the design specifications. It is based on the original code verification and only supports the C # language. It is a tool for code verification during development. I believe that in the daily development, it will help you to gradually improve and enhance your coding standards and awareness while using the tools. It is recommended that you read the book ".net design specifications-.net conventions, consistent usage and patterns".

First of all, first download the latest version of StyleCop., download address: http://stylecop.codeplex.com/, an easier way is in VisualStudio, Tools-- > Extensions and Updates … -> Extensions and Updates... -- > Online-- > search for stylecop, find Visual StyleCop and install it.

After the installation is complete, open Visual Studio and open a project, right-click a Project, you will find that there are three more options.

Run StyleCop and Run StyleCop (RescanAll) review the existing code and display the Warning that does not conform to the specification in the code in Error List. The following figure shows the Error List with Run StyleCop executed.

StyleCop Setting: in the actual project, the existing rules may not apply to our project, and we need to configure them through StyleCop Setting.

The rules for StyleCop inspection include:

Layout (Layout ofelements, statements, expressions, and query clauses)

Parenthesis position (Placement ofcurly brackets, parenthesis, square brackets, etc)

Space (Spacing aroundkeywords and operator symbols)

Line spacing (Line spacing)

Parameter position (Placement ofmethod parameters within method declarations or method calls)

Standard arrangement of elements (Standardordering of elements within a class)

Comment format (Formatting ofdocumentation within element headers and file headers)

Naming (Naming ofelements, fields and variables)

Use of built-in types (Use of thebuilt-in types)

Use of access modifiers (Use of accessmodifiers)

File contents (Allowed contentsof files)

Debugging text (Debugging text)

After reading the above, do you have any further understanding of how to use StyleCop for code review? If you want to know more knowledge or related content, please follow the industry information channel, thank you for your support.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.