Measurement Help

How to Measure Files

  1. If a suitable rule is not yet defined, this must be done before measuring any files (see How To Create A Rule).
  2. Select the Compare Files link located at the top of the page (note: Compare Files is used whether a comparison or non-comparison measure is desired).
  3. Select the desired rule from the dropdown list (REQUIRED). For more information about rules, see How To Create A Rule.
  4. Enter the session name (optional). Each session has a date code assigned automatically, if you don't provide a session name. Duplicate session names on the same day are not allowed.
  5. Under "Old Version Directory", enter the directory path to where the old version of the files reside. You may also browse to the desired location with the button marked "..."
  6. Select the Get Files button (next to the Old Version Directory text box).
  7. If the directory is valid, the text area will fill with the all the filenames residing in that directory (and any of its subdirectories). If the directory is invalid, no file names will appear in the text box.
  8. Under "New Version Directory", enter the directory path to where the new version of the files reside. You may also browse to the desired location with the button marked "..."
  9. Select the Get Files button (next to the New Version Directory text box).
  10. If the directory is valid, the text area will fill with the all the filenames residing in that directory (and any of its subdirectories).
  11. Select the "Compare Files" button.
  12. If all the information is correct, a confirmation message will appear.
  13. Click the "Yes" button to continue the measurement.
  14. Depending on how many files you are measuring and the size of each file, this may take some time. Please Note: The application opens all the files in the directory as ASCII. So if you have binary files in the directory, you may have abnormal or unpredictable results. It is best to remove binary files from your list of files, if possible.
  15. After the measurement is complete, a report of your results will be displayed.

Measurements

EZ-Metrix measures lines of code, comments and blanks according to the following concept. In general, each line within a file falls into only one of 3 possible categories, as shown below:

  1. Code (includes lines that contain both source code and comments on the same physical line)
  2. Comments (includes multi-line comments with embedded blank lines)
  3. Blanks (lines with only white space {spaces and tabs} and a carriage return)
Pie Chart

Detailed measurement definitions (which appear in reports) - Non-Comparison

Session Information

  • Compare Date: The date when the measurement was performed.
  • Session ID: An ID (number or user-defined name) which uniquely identifies the measurement session.
  • Session Name: A unique name (user-provided) or number (if user does not provide a name) for this measurement session. This is the name that appears in the list of reports.
  • Rule ID: The name of the rule chosen to be used for this measurement session
  • Compare Type: "Non-comparison Line Count"

Directory Results

  • Directory Path: This shows the root directory for all measured files
  • Total Files in Directory: The number of files measured (does not include the number of directories/folders).

File Results (for each file measured)

  • Filename: The file name and file extension
  • Comment Lines: The number of single line and multi-line comments in the file named above (as defined by the rule shown above).
  • Blank Lines: The number of lines with nothing but white space {spaces or tabs} and a carriage return in the file named above.
  • Source Code Lines: The number of physical lines of source code in the file named above.
  • Total Lines in File: The number of lines of code + comments + blanks in the file named above.

Detailed measurement definitions (which appear in reports) - Comparison

Session Information

  • Compare Date: The date when the measurement was performed.
  • Session ID: An ID (number or user-defined name) which uniquely identifies the measurement session.
  • Session Name: A unique name (user-provided) or number (if user does not provide a name) for this measurement session. This is the name that appears in the list of reports.
  • Rule ID: The name of the rule chosen to be used for this measurement session
  • Compare Type: "Comparison Line Count"

Directory Results

  • Old Files Directory Path: This shows the root directory for the baseline (i.e., old) files
  • New Files Directory Path: This shows the root directory for the modified (i.e., new) files
  • Same Files: The number of files that have the same file name between the old and new versions.
  • Deleted Files: The number of files that were removed between the old and new versions (files which appear in the old directory, but not in the new directory).
  • New Files: The number of files that were added between the old and new versions(files which appear in the new directory, but not in the old directory).

File Results (for each file measured)

  • Filename: The file name and file extension
  • New Lines: The number of lines of code and comments that are in the new file and not in the old file of the same name. Note: For a modified line to be considered new, the number of changed characters must exceed the value of the threshold defeined in the rule named above.
  • Deleted Lines: The number of lines of code and comments that are in the old file and not in the new file of the same name. Note: For a modified line to be considered deleted, the number of changed characters must exceed the value of the threshold defeined in the rule named above.
  • Same Lines: The number of lines of code and comments that are identical between the old and new file named above.
  • Changed Lines: The number of lines of code + comments + blanks in the file named above. Note: For a modified line to be considered changed, the number of changed characters in the file must NOT exceed the value of the threshold defeined in the rule named above.
  • Comment Lines in Old File: The number of lines of single and multi-line comments in the old file.
  • Comment Lines in New File: The number of lines of single and multi-line comments in the new file.
  • Blank Lines in Old File: The number of blank lines in the old file, not including those embedded in multi-line comments.
  • Blank Lines in New File: The number of blank lines in the new file, not including those embedded in multi-line comments.
  • Source Code Lines in Old File: The number of physical lines of code in the old file.
  • Source Code Lines in New File: The number of physical lines of code in the new file.
  • Same lines of code: The number of physical lines of code that are identical between the old and new versions of the file named above.
  • Same lines of comments: The number of lines of comments that are identical between the old and new versions of the file named above.
  • New lines of code: The number of physical lines of code that are new (added) to the old version of the file named above. Note: For a modified line to be considered new, the number of changed characters in that line must exceed the value of the threshold defeined in the rule named above.
  • New lines of comments: The number of physical lines of comments that are new (added) to the old version of the file named above. Note: For a modified line to be considered new, the number of changed characters in that line must exceed the value of the threshold defeined in the rule named above.
  • Deleted lines of code: The number of physical lines of code that were deleted (removed) from the old version of the file named above. Note: For a modified line to be considered deleted, the number of changed characters in that line must exceed the value of the threshold defeined in the rule named above.
  • Deleted lines of comments:The number of lines of comments that were deleted (removed) from the old version of the file named above. Note: For a modified line to be considered deleted, the number of changed characters in that line must exceed the value of the threshold defeined in the rule named above.
  • Changed lines of code: The number of lines of code modified from the old version of the file named above. Note: For a line to be considered changed, the number of changed characters in the file must NOT exceed the value of the threshold defeined in the rule named above.
  • Changed lines of comments:The number of lines of comments modified from the old version of the file named above. Note: For a line to be considered changed, the number of changed characters in the file must NOT exceed the value of the threshold defeined in the rule named above.