|
 |
|
|
| |
Standards Master 2.0 is a Microsoft ® Visual Basic ® 5.0 and 6.0 Add-In that
checks VB code against a configurable set of standards. Whenever activated,
Standards Master 2.0 will generate a list of violations of your own coding
standards. It then provides an easy-to-use mechanism for correcting the
problems - all from within the Visual Basic Integrated Development Environment.
There is no need to run a separate application after you have finished coding,
since Standards Master 2.0 checks your code while you work. And best of all you
do not have to put up with other products' arbitrary default standards -
Standards Master 2.0 allows you to configure everything!
Standards Master 2.0 requires Visual Basic 5.0 with Service pack 3 or higher
installed, or Visual Basic 6.0. It will run on Windows® 95, Windows® 98,
Windows® ME, Windows® NT 4.0, and Windows® 2000 or higher.
Standards Master 2.0 is a feature-packedadd-in:
 |
| |
Standards Master allows you to configure different prefixes or suffixes for the
scopes and usage types of all variables and constants. You can set up several
different prefixes for the same scope or type to allow flexibility in naming
standards, or you may choose to have Standards Master ignore these checks. |
|
| |
You may also establish separate naming conventions for the types you define
within your coding, including User-Defined Types, Enums, and Classes. As with
variables, type prefixes or suffixes may be configured in any way you would
like. |
|
| |
If desired, Standards Master will check the controls on your forms to see if
they conform to the standards you define. Control types can be added manually,
or Standards Master will prompt you automatically. |
|
| |
Standards Master can also check your code for various aspects of coding style,
such as: |
|
use of GoTos and GoSubs |
|
use of "magic" numbers and string literals |
|
explicit typing of variables, constants, and functions |
|
implicit usage of Boolean comparisons and the ByRef keyword
|
|
use of single line If/Then contructs |
|
use of variable after Next statements |
|
use of type declaration characters |
|
multiple variable declarations on one line |
|
and much more... |
|
|
| |
Standards Master features 2 different interfaces to suite your needs. The first
is a simple list box that contains any errors it has found in your code. It is
both fully sortable and highly interactive. Double-clicking on an error in the
list takes you directly to the problematic code. Right-clicking reveals a list
of suggestions for correcting the problem. Choose a suggestion and Standards
Master will fix the error for you. Fixed errors appear in different colors, and
you may even sort errors by error type, description, project and module. In
many cases, Standards Master can fix all errors selected in the list
simultaneously. The second interface, called Wizard Mode, allows you to review
your errors one at a time, and fix them as needed. Its a like a grammar-checker
for your code! |
|
| |
All standards you establish, including commenting templates, may be easily
published to a common location for use by others in your development group. |
|
| |
Standards Master also contains a powerful group of commenting tools. You may
insert flowerboxes, revision history comments, and inline comments all at the
touch of a button. Standards Master generates the comments from templates you
define and may contain replaceable parameters you create and insert. When
needed, you will automatically be prompted for a value for your parameter. You
may also have Standards Master remember that value for your entire coding
session, eliminating redundant typing.
Standards Master will automatically place the comments you insert in the right
location within your procedure, regardless of your current cursor location:
flowerboxes can go before or after your procedure declarations; revision
history comments go before or after the final line of the flowerbox; and inline
comments are smart enough to "push" themselves onto the line above the line of
code you are working on if they are too long. |
|
| |
Standards Master now features a robust code formatter that automatically
indents and outdents your code according to the block structures you define.
You may format automatically as Standards Master checks your code, or run the
formatting tool separately on those modules you choose. |
|
| |
Standards Master will produce a comma-delimited file on demand containing
number of logical and physical lines, number of lines of whitespace, number of
lines of comments, the number of lines containing only comments, errors found
and errors fixed. You may import this simple file may into your favorite
database or spreadsheet for further analysis. |
|
| |
Standards Master also allows you to create exceptions to errors in variable
names. Errors are not reported for variables in the exceptions list. This is
useful for those VB generated event handler parameters that never match your
standards. |
|
| |
Standards Master checks filenames, too. |
|
| |
Standards Master 2.0 also has numerous other miscellaneous enhancements that
are sure to make your programming experience much more productive. |
When companies start projects with teams of two or more programmers, they have
great intentions of creating a well-defined code base from which products can
be constructed. They create coding standards and sometimes even formalize them
and put them in writing for the programmers to review and use. A few companies
even have periodic code reviews to ensure that the programmers are following
the guidelines.
Ever changing business requirements and fast-approaching deadlines force
projects into cutting corners, and coding standards (whether documented or
not), are usually the first thing to go.
To be fruitful, coding standards must be in place and followed all of the time,
not just when time allows. If coding standards are ignored for some code, they
might as well not be used for any of it.
Standards Master takes the headache out of maintaining coding standards and
keeping code up to those standards. Its robust options allow a company or group
of programmers to select the options with which they are comfortable. This
provides both a documented standard and a flexible way of enforcing it. And
since it operates interactively, programmers always have access to the
standards. With Standards Master code can be written up to standards, rather
than brought up to standards at some later (probably never) date.
will enjoy Standards
Master because it is unobtrusive. They can work at their own pace and then
check standards when they have finished the coding session. Standards Master's
simple interface allows programmers to make changes while they still have the
code right in front of them, and its suggestion mechanism makes it easy to
correct those difficult to remember naming conventions. There is no need to
quit VB and no need to print out long reports. Its "check this module only"
option allows an individual member of a team to concentrate on the code being
written at that time - not on everyone else's.
will find that code
checked by Standards Master is more maintainable and therefore cost efficient.
Consistent application of coding standards not only makes training and
familiarizing new employees with the code easier, but also facilitates
inter-departmental work for employees moving from project to project.
will also find Standards Master
useful, since it allows them to develop consistent programming habits.
|
|