SSW Code Auditor > User Guide

Code Auditor Logo

These are the old screens so you can reminisce... See how much better the UI is in the current version.

Automate your Code Reviews with SSW Code Auditor

SSW Code Auditor User Guide
1. Running SSW Code Auditor Wizard
2. Creating New Rule
3. Creating Regular Expression
4. The Reports

  1. 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.

    Code Auditor Welcome Screen
    Figure: Run SSW Code Auditor.

    Select Job
    Figure: Select a predefined Job, or create a new one.

    Select Files
    Figure: Add the paths to scan.

    Available scan types
    Figure: Available scan types - Files, Folders, and URLs.

    Select Rules
    Figure: Select the rules you want to run.

    Email Schedule
    Figure: Indicate where you'd like the report issued to.

    Ready to start
    Figure: Ready to start the scanning process.

    Scanning in progress
    Figure: Scanning in progress.

    Finished
    Figure: Finished! View the report to see the scan result.



  2. Creating New Rule

    To create a new rule for a Job:

    1. Select the designated Job and click next to the Rules Definition page.
    2. Click "Add" on the bottom left of the Rules ListBox.
    3. Select "Create a new rule" from the radio option and enter name for the new rule.
      Add new rule
      Figure: Create a new rule.


    4. Search tab
      Figure: Add the search information and regular expression.

    5. Enter the replacement text to automatically fix your code.
      Replace tab
      Figure: Replacement text of this rule.


    6. Exceptions tab
      Figure: Rule exceptions.


    7. Notes tab
      Figure: Notes of this rule.


  3. Create Regular Expression

    The following images show how to create your expression.

    Regular Expression Wizard
    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.

    Regular Expression Wizard 2
    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.

    Regular Expression Wizard 3
    Figure: The wizard also shows you any group matchings, this information is not directly used in Code Auditor, but it is quite useful elsewhere especially if you work with regular expressions quite a bit!

    Regular Expression Wizard 3
    Figure: You see check the regular expression in a more human readable way here.

    More information on regular expressions.


  4. The Reports

    Sample Report
    Figure: Job Report