Home > Products > Code Auditor > Screenshots
Automate your Code Reviews with SSW Code Auditor
As a project or company grows, managing code standards throughout your team becomes virtually impossible.
But consistent code is crucial to future development and maintenance. SSW Code Auditor lets you
take control of your code and automatically review your web apps and projects - giving you more opportunity to
spend time where it really matters.
Here at SSW, we face the problem of maintaining our standards across nearly five thousand web pages, over
twenty active projects in both Visual Basic (6 and .NET) and C-Sharp. There comes
a point where a tool to check (or audit) our work would need was needed, this tool is SSW Code Auditor.
How do you plan on using SSW Code Auditor
-
Prerequisites
-
Running SSW Code Auditor Wizard
When you run the SSW Code Auditor there will be a step by step wizard to guide you through the
audit process.
Figure: Run SSW Code Auditor
Figure: Select a predefined Job or create a new one
Figure: Add the paths to scan
Figure: Available scan types - Files, Folders, URLs, VS Solutions and Projects
Figure: Select the rules you want to run
Figure: Indicate where you'd like the report issued to
Figure: Command line
Figure: Ready to start the scanning process
Figure: Scanning in progress
Figure: Results are in! Let's view the report
Figure: Finished! Thanks for using SSW Code Auditor
-
Creating New Rule
To see a detailed walkthrough of how to create a new regular
expression rule from scratch, see the Regular Expression
Rule Tutorial.
To create a new rule for a Job:
- Select the designated Job and click next to the Rules Definition page.
- Click "Add..." on the bottom right of the Rules ListView.
- Select "Create a new rule" from the radio option and enter name for the
new rule.
Figure: Create a new rule
Figure: Choose different methods to create a new rule
-
Add general information of this rule.
Figure: General information of this rule
-
Enter the regular expression used by this rule and a regular expression in the search-in field to filter the files this rule run on.
Figure: Search information of this rule
Figure: C# code for another rule search pattern
-
Tick the checkbox and enter the replacement text to automatically fix your code.
Figure: Replacement text of this rule
-
You can test your regular expression on some simple test string before running it on your projects.
Figure: Simple regular expression testing
-
Figure: Change history of this rule
-
Figure: Statistics of this rule
-
Figure: Rule exceptions
-
Create Regular Expression
The following images show how to create your expression.
Figure: SSW Code Auditor also comes with an easy to use yet powerful Regular Expression wizard.
You can use it to build patterns if you are not familiar with regular expressions.
Figure: The wizard also shows you any group matchings, this information is
very useful when you are building find & replace patterns
Figure: For the advanced users, the wizard provides a complete testing ground for all the features
of .NET Regular Expressions, as well as two test areas (sand box) for you to test in one go
Figure: You see check the regular expression in a more human readable way
here
More information on regular expressions.
-
The Reports
Figure: Job Report - before (Bad)
Figure: Job Report - after (Good)
-
Tools | Options
Figure: Code Auditor Settings for Reports
Figure: Code Auditor Settings for TFS Check-in Policy
Want to reminisce – see the old page + screenshots