Using the Code Commenting Conformity Tool

The CodeSMART Code Commenting Conformity tool will help you identify poor commented code blocks.

To check for code commenting conformity:

1. Open the project you want to check.
2. Click Code Commenting Conformity on the Reviews popup from the Other Tools toolbar or select the same entry in the CodeSMART Reviews menu in order to display the Code Commenting Conformity dialog box (quick toolbar and menu references are available).

   

3. Select the operation scope. Depending on the current position in code and the active code or designer window, only valid options are listed.
4. Specify if you want to check components and procedures for descriptive comment headers.
5. You may also specify the maximum amount of contiguous uncommented lines which you consider acceptable for the selected scope.
6. Click Begin to start the code commenting conformity check. CodeSMART will detect and report all pure code blocks that don't have comments and exceed the specified number of lines. Each block position is retained and displayed in the Reviews pane. Double-clicking an item in the grid navigates you to the beginning of each block.

   

 Note

• The results in the list can be refreshed, deleted, printed, exported and the pane view can be customized all using the pane's shortcut menu commands.

Back to top