Review Mandatory Text

The Review Mandatory Text feature allows you to execute reviews that you create to detect that you are using "mandatory text" in your source code. "Mandatory text" is defined by you and typically is something that you want to appear in the source code. This feature is specially useful in organizations to enforce some coding standards. For example, a review of mandatory text can be created to detect that a copyright notice is included in every file of your project, or that each procedure has a header formatted according to a standard.

MZ-Tools offers the following ways to review mandatory text:

• The MZ-Tools | Other Utilities | Review Mandatory Text... menu.
• The Other Utilities | Review Mandatory Text... menu on the MZ-Tools toolbar.
• The keyboard shortcut associated with the MZTools6_VSXXXX.ReviewMandatoryText command.

When you invoke this feature, a dialog window is shown that allows you to select the scope of the operation. The results are shown in a Result Window.

You create the reviews in the Corporate Options window, Review Mandatory Text section. For each review, you must define the mandatory text (which can use regular expressions), the .NET language which it applies to, the kind of file which it applies to, the level (file, class, procedure, etc.) and other properties.

Each review can be launched automatically before a build in Release configuration. If a failed review is detected, the Result window keeps open (otherwise it is closed). You should fix the failed reviews before building the executable.

Remarks:

• Ensure that the source code can be compiled without errors before running this feature.

See Also:

Result Window

Review Mandatory Text Options

Review Properties

Keyboard Shortcuts Options