Keep your code healthy
Are you looking to eradicate bugs and ensure consistency? SSW Code Auditor is a code analysis
tool that allows developers to take control of your code, ensuring large, complex
source code can be simplified, cleaned and maintained. The built-in rules focus
on the most popular .NET languages (C#, VB.NET) for both Windows Forms and ASP.NET;
however, the flexibility of SSW Code Auditor allows the developer to add their own
rules to target any language in any text file.
As a project or company grows, managing code standards throughout your team becomes
virtually impossible. 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#. There comes a point where a tool to check our work is needed, this tool
is SSW Code Auditor.
SSW Code Auditor utilizes the power of Regular Expressions to audit your code. This
powerful feature permits the user to write their own set of rules and have different
rules for different projects.
Key Features & Benefits
SSW Code Auditor allows to you:
- Verify that coding standards are maintained
- Prevent bad coding practices
- Seamlessly integrates with VS.NET
|
Great, user-friendly wizard style interface With our
standards compliant user interface, you are sure to have a consistently
great operating environment with SSW products.
|
|
Make your own rules! With our powerful regular expression enabled parsing
engine, you have the flexibility to scan any text file for any kinds of rules. Rules
can check specific filetypes and have exceptions based on other regular expression
matches.
|
|
Stay on top of things... Code Auditor has in-built scheduling and email notification
functionality so you can have regular reminders of what needs attention in your
projects!
|
|
Spanning the big picture Scan any number of directory trees with extensible
path selection. As many development projects can be covered by your rules as you
wish.
|
|
Report Output See a sample good report
from the Code Auditor process.
See a sample bad report from the Code Auditor
process.
|
|
Visual Studio Add-in Audit your project directly from Visual Studio with
just a click.
**Works in Visual Studio 2003 and 2005 **
See the tutorial.
|
|
Team Foundation Studio Add-in Automatically adds an additional Check-in policy
that runs SSW Code Auditor and stops developers from check in code that violates
rules.
Custom check-in policy for VSTS Whitepaper
|
|
Built-in sample projects & sample database We offer a sample database and
kinds of sample projects to help you run a professional demo scan.
|
More Technical Features include the ability to:
- Check any text file
- Check file names
- Scan project directories for code that violates your rules
- Perform deep traversal of directories
- Scan websites for HTML that violates your rules - including the information served
by the web server!
- Validate HTML code by using the Tidy HTML engine
- Use the report that is written to an .mdb, or to export to XML
- Organize separate projects into jobs
- Allow exceptions to rules, thus ignoring files that you are aware of
- Full scheduling abilities with email alerts, providing regular automated checks
on your code base.
- Use Regular Expression to define more rules
- Regular Expression builder included
See more screenshots in the Code Auditor User guide.
Upcoming Features
- TFS Check-in policy for VS2008/TFS2008
- Auto update rules from our webservice
- Share your rules with others
- Release 17 - Upgrade to LINQ
System Requirements
Predefined Rules - these are the most popular built in rules
Professional developers consider it really important to keep their application/website in good shape.
Regular code reviews with Software Architects are important and expensive.
Save money and use Code Auditor before any manual code review.
Some of the Code Auditor rules are big and some are small. Their business value adds up.
For example, if Google doesn’t index your page because of some minor issue that you never thought about, that will
decrease the traffic to your site. Take advantage of the years of experience in the Code Auditor rules and get your application following many of the industry standards and programming best practices.
Top 5 rules:
-
FONT tags must not be used
Reason: Did you know if you code your styles correctly, you can change them in one place.
To get better web styling remove FONT and BASEFONT tags. BTW they are
deprecated by W3C
so they will be removed in a future version of HTML.
More Info ...
-
Google File Size Limit
Reason: Did you know if your web page is greater than 2.5MB,
it will not be indexed by Google.
More Info ....
-
Table tags should not specify the width
Reason: Did you know that Table tags should not specify the width
More Info ...
-
Use Standard width for Ellipsis button.
Reason: Did you know that there is a convention for the width of an 'Ellipsis' button.
More Info ....
-
A Windows Form should have a minimum size to avoid unexpected UI behavior.
Reason: Did you know that a user can make a form unusuable so you need to keep a minimum size for each window form.
More Info ...
More Rules ..
Do they go in Code Auditor
or Link Auditor?
What does the unregistered version give me?
In respect to the unregistered version we know you want to see it working before
you buy it. We aim for that.
Note: we also give free version targeted to the little guys
More details see http://www.ssw.com.au/ssw/KB/KB.aspx?KBID=Q658302
SSW provides free phone and email support to answer queries on registered products.
How to show that your application is 'SSW Code Auditor' Compliant
To show your users that you have taken the care to create a 'healthy' code, you
may display this icon on any web pages and applications that validates.
For web pages:
Here is the HTML you could use to add this icon to your web page:
<p>
<a href="http://www.ssw.com.au/ssw/CodeAuditor">
<img src="http://www.ssw.com.au/ssw/CodeAuditor/Images/codeauditorcompliant.gif"
alt="Code Auditor compliant" height="50" width="148" /></a>
</p>
Download the logo in PNG
or GIF format.
Where should I put this icon?
We recommend that the logo to be placed on your website footer or in the About
Box if it's a winform application.
Getting Support
If you can't find it in the product documentation then check our
knowledge base for further information and tips about this product.
If you think that one of our rules is incorrect then please
tell us about it.
Please send us bug reports
and
feedback so that we can evolve our software into a product that matches
your requirements. We guarantee a response.
I'm Sold... What's next?